<access-service>/api/v1/userwhitelist/{objectId}

URL structure

https://access-service.xy-company.com/api/v1/userwhitelist/{objectId}

where {objectId} is the ID of a user whitelist rule.

Supported methods and overview

• GET ( Deprecated ) - used to retrieve information about an existing user whitelist rule (specified by objectId) in any organization, available to Safe Share administrators only.

Notes:

• This endpoint is deprecated and should no longer be used. Organization administrators can retrieve information about existing user whitelist rules by calling the GET method on the <access-service>/api/v1/organisations/{orgId}/userwhitelist API endpoint.
• This method takes no parameters.

Detailed description

This API endpoint retrieves information about an existing user whitelist rule (specified by objectId) in any organization, available to Safe Share administrators only. This ID can be obtained from a GET method to the <access-service>/api/v1/organisations/{orgId}/userwhitelist API endpoint, which retrieves a list of information for all current user whitelist within an organization (specified by orgId).
Tip: All information returned in the response to this API endpoint is also returned in the response from a GET method call to the <access-service>/api/v1/organisations/{orgId}/userwhitelist endpoint. Therefore, if you do not already have a user whitelist rule's ID, there is no need to call the GET method on this API endpoint.

Supported roles

This API endpoint supports the following Covata user roles (as described in the Safe Share Administrator's Guide):

• Safe Share administrator

The Covata Platform's resources available to a Covata user meeting the criteria above is determined by the access token submitted in the header of requests to this endpoint.

Required headers

The appropriate access token as the Bearer token:

• Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

Returns

A JSON-formatted response containing the following members:

• id - The ID of the user whitelist rule, which should match {objectId} in the request's URL.
• pattern - The domain or email address of this user whitelist rule.
• description - The description of this user whitelist rule.
  Example (response):

  {
      "id": "765456269464346624",
      "pattern": "xy-company.com",
      "description": "XY Company staff"
  }