<access-service>/api/v1/userwhitelist/bulk

URL structure

https://access-service.xy-company.com/api/v1/userwhitelist/bulk

Supported methods and overview

• POST - used to remove one or more existing user whitelist rules (based on their user whitelist rule IDs), in a single action.

Detailed description

This API endpoint deletes one or more existing user whitelist rules from the Covata Platform.

Deleting one or more user whitelist rules (with at least one remaining) is likely to disable several Covata user accounts. Hence, before performing this action, it is advisable to first check which Covata user accounts will be disabled by calling the <access-service>/api/v1/userwhitelist/check API endpoint with an action parameter value of delete in the JSON object, along with the ids (i.e. of each whitelist rule to be deleted) in the items array.

It is also possible to delete a single user whitelist rule by calling the DELETE method of the <access-service>/api/v1/userwhitelist/{userwhitelistId} API endpoint.

Deleting the last user whitelist rule on the Covata Platform results in the user whitelist feature being disabled. When the user whitelist feature is disabled, be aware that:

• Covata user accounts are not disabled by not having a user whitelist rule.
• Directly disabling or re-enabling Covata user accounts has no impact on the user whitelist feature.
• Any LDAP user accounts that were disabled by not matching/complying with a user whitelist rule (when the user whitelist feature was enabled) are automatically re-enabled when the Covata Platform next synchronizes with the LDAP server.

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

The following header is required if the body of the request has a JSON object:

• Content-Type: application/json

Required parameters

The following required parameter must be sent in the URL of the POST request:

• action - delete.

• description - .

  Example ():

The following required parameter must also be sent in the body of the POST request, as an individual member of a JSON object:

• ids - an array of user whitelist rule IDs.

  Example ():

Returns

If the request succeeded, then an HTTP response status 200 OK is returned.