Skip to main content

​
URL structure

where {ldapconnectionId} is the ID of a LDAP connection.

​
Supported methods and overview

  • PUT - used to enable or disable an existing LDAP connection, based on its ID.
This method takes no parameters.

​
Detailed description

This API endpoint enables or disables an LDAP connection, using the LDAP connection’s ID. Calling this endpoint on a given LDAP connection successively toggles between enabling and disabling this LDAP connection. The LDAP connection’s ID can be obtained by calling the GET method on the <access-service>/api/v1/ldap API endpoint, which retrieves a list of field information for all LDAP connections configured on the Covata Platform.

​
Supported roles

This API endpoint supports the following Covata user roles (as described in the Covata Platform 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

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