Skip to main content

​
URL structure

​
Supported methods and overview

​
Detailed description

This API endpoint verifies the connection to an LDAP user directory. With this request, a core subset of LDAP connection parameters must be submitted, which includes the:
  • address of the server running LDAP (along with the connection timeout duration),
  • LDAP user directory’s manager credentials (to perform LDAP authentication and synchronisation),
  • root node in LDAP from which the Covata Platform finds users and groups and
  • LDAP field against which the Covata Platform matches the email address of a Covata user when they authenticate.

​
Supported roles

This API endpoint supports the following Covata user roles (as described in the SafeShare Administrator’s Guide): The Covata Platform’s resources available to a Covata user meeting the criteria 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:
  • Authorisation: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...
The following header is required if the body of the request has a JSON object:
  • Content-Type: application/json

​
Required parameters

The following required parameters must be sent in the body of the POST request, each as individual members of a JSON object:
  • serverUrl - .
  • serverTimeout - .
  • managerDN - .
  • managerPassword - .
  • baseDN - .
  • authFilter - .
    Example (request):

​
Returns

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