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.

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 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

Returns

A JSON-formatted response containing the following members:

  • 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:

    {
    "totalLdapConnections": 1
    }