API Documentation
Toggle TOC panel
<access-service>/api/v1/dashboard/ldap

URL structure

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

Supported methods and overview

  • GET - used to retrieve the total number of currently enabled LDAP connections on the Covata Platform.

Note: This method takes no parameters.

Detailed description

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

This information is utilized on the Safe Share Administration dashboard.

Supported roles

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

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

Required headers

The appropriate access token as the Bearer token:

  • Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

Returns

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):
    {
    "totalLdapConnections": 1
    }