> ## 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/dashboard/ldap

## URL structure&#x20;

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

## Supported methods and overview&#x20;

* `GET` - retrieves the total number of currently enabled [LDAP connections](/3.5/admin-platform/configuring-ldap.md) on the Covata Platform.

> [!NOTE]
>
> This method takes no parameters.

## Detailed description&#x20;

This API endpoint retrieves the total number of currently enabled LDAP connections on the Covata Platform.

This information is utilised on the [SafeShare Administration dashboard](/3.5/admin-platform/accessing-platform-administration.md#the-platform-administration-dashboard).

## Supported roles&#x20;

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

* [SafeShare administrator](/3.5/admin-platform/administering-platform-administrator-users.md#platform-administrator-role)

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

## Required headers&#x20;

The appropriate access token as the `Bearer` token:

* `Authorisation: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...`

## Returns&#x20;

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

For successful requests only, a JSON-formatted response containing the following members is also returned:

* **totalLdapConnections** - The total number of currently enabled LDAP connections on the Covata Platform. Any LDAP connections which have already been configured on the Covata Platform but are disabled are not represented in this total. \

  **Example (response):**

  ```json theme={null}
  {
      "totalLdapConnections": 1
  }
  ```


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