<access-service>/api/v1/dashboard/whitelist

URL structure

https://access-service.xy-company.com/api/v1/dashboard/whitelist

Supported methods and overview

• GET - used to retrieve the total number of user whitelist entries (both individual email addresses and domains) currently configured on the Covata Platform.

Note: This method takes no parameters.

Detailed description

This API endpoint retrieves the total number of user whitelist entries (both individual email addresses and domains) currently configured on the Covata Platform.

Supported roles

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

• System administrator

The Covata Platform's resources available to one of these Covata users (above) is determined by the access token passed in the header of requests to this endpoint.

Required headers

The appropriate access token as the Bearer token:

• Authorization: Bearer a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6

Returns

A JSON-formatted response containing the following members:

• totalDomainsWhiteListed - The total number of user whitelist entries (both individual email addresses and domains) currently configured on the Covata Platform.

  Example:

  {
    "totalDomainsWhiteListed": 2
  }