> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cocoondata.com/llms.txt
> Use this file to discover all available pages before exploring further.

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

## URL structure&#x20;

```text theme={null}
https://access-service.xy-company.com/api/v1/userwhitelist/bulk
```

## Supported methods and overview&#x20;

* `POST` - used to [delete](/2.16/admin/managing-user-whitelists.md#deleting-existing-user-whitelist-rules) one or more existing [user whitelist rules](/2.16/admin/managing-user-whitelists.md) (based on their user whitelist rule IDs), in a single action.

## Detailed description&#x20;

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](/2.16/admin/administering-users.md) 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](/2.16/api/access-service-api-v1-userwhitelist-check.md) API endpoint with an **action** parameter value of **delete** in the JSON object, along with the **id**s (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}](/2.16/api/access-service-api-v1-userwhitelist-userwhitelistid.md) 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](/2.16/api/access-service-api-v1-users-bulk.md) by *not having a user whitelist rule*.
* Directly [disabling or re-enabling Covata user accounts](/2.16/api/access-service-api-v1-users-userid-enable.md) has no impact on the user whitelist feature.
* Any [LDAP](/2.16/admin/administering-users.md#account-type) 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&#x20;

This API endpoint supports the following Covata user [roles](/2.16/admin/administering-users.md#a-users-roles) (as described in the [Covata Platform Administrator's Guide](/2.16/admin.md)):

* [System administrator](/2.16/admin/administering-users.md#system-administrator-role)

The Covata Platform's resources available to one of these Covata users (above) is determined by the access token passed in the [header](/2.16/api/access-service-api-v1-userwhitelist-bulk.md#access-service-api-v1-userwhitelist-bulk-required-headers) of requests to this endpoint.

## Required headers&#x20;

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&#x20;

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&#x20;

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


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.