> ## 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/{objectId}

## URL structure&#x20;

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

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

## Supported methods and overview&#x20;

* `GET` ( *Deprecated* ) - retrieves information about an existing [user whitelist rule](/3.4/admin-org/managing-user-whitelists.md) (specified by `objectId`) in any organization, available to Safe Share administrators only.

> [!NOTE]
>
> * 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](/3.4/api/access-service-api-v1-organisations-orgid-userwhitelist.md) API endpoint.
> * This method takes no parameters.

## Detailed description&#x20;

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](/3.4/api/access-service-api-v1-organisations-orgid-userwhitelist.md) 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](/3.4/api/access-service-api-v1-userwhitelist-objectid.md#access-service-api-v1-userwhitelist-objectid-returns) to this API endpoint is also returned in the [response](/3.4/api/access-service-api-v1-organisations-orgid-userwhitelist.md#access-service-api-v1-organisations-orgid-userwhitelist-returns) from a `GET` method call to the [\<access-service>/api/v1/organisations/\{orgId}/userwhitelist](/3.4/api/access-service-api-v1-organisations-orgid-userwhitelist.md) 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&#x20;

This API endpoint supports the following Covata user [roles](/3.4/admin-platform/administering-platform-administrator-users.md#platform-administrators-and-user-roles) (as described in the [Safe Share Administrator's Guide](/3.4/admin-platform.md)):

* [Safe Share administrator](/3.4/admin-platform/administering-platform-administrator-users.md#platform-administrator-role)

The Covata Platform's resources available to a Covata user meeting the criteria above is determined by the access token submitted in the [header](/3.4/api/access-service-api-v1-userwhitelist-objectid.md#access-service-api-v1-userwhitelist-objectid-required-headers) of requests to this endpoint.

## Required headers&#x20;

The appropriate access token as the `Bearer` token:

* `Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...`

## Returns&#x20;

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):**

  ```json theme={null}
  {
      "id": "765456269464346624",
      "pattern": "xy-company.com",
      "description": "XY Company staff"
  }
  ```


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