> ## 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. # /api/v1/ldapconnections ## URL structure ```text theme={null} https://access-service.xy-company.com/api/v1/ldapconnections ``` ## Supported methods and overview * `POST` - adds a new [LDAP connection](/3.5/admin-platform/configuring-ldap.md). * `GET` - retrieves a list of field information for all LDAP connections configured on the Covata Platform. > [!NOTE] > > The `GET` method takes no parameters. ## Detailed description This API endpoint serves a number of purposes: * Adds a new connection to an LDAP server/user directory on the Covata Platform. \ **Notes:** * Before calling this API endpoint: * Be aware that adding at least one LDAP connection (through this API endpoint) *permanently disables* the ability to add more organisations to the Covata Platform - i.e. doing so permamently disables successful calls to the `POST` method on the [\/api/v1/organisations](/3.5/api/access-service-api-v1-organisations.md) endpoint. * Ensure that at least one plan has been configured in the one organisation configured on the Covata Platform instance. For more information see [\/api/v1/organisations/\{orgGroupId}/plans](/3.5/api/access-service-api-v1-organisations-orggroupid-plans.md). * To test that the Covata Platform can successfully connect to the LDAP server/user directory first before adding the LDAP connection itself, call the [\/api/v1/ldapconnections/availability](/3.5/api/access-service-api-v1-ldapconnections-availability.md) API endpoint (before calling the `POST` method on this API endpoint). * All accounts in the LDAP user directory will appear as new user accounts in the one configured organisation when the Covata Platform next synchronises with the LDAP server. * All new LDAP user accounts added to the Covata Platform from an LDAP server/user directory automatically have the [Originator](/3.5/admin-org/administering-users-within-an-organisation.md#originator-role) role and are assigned the **default** plan. * If the email address of an existing user account on the Covata Platform matches that of the **emailField** of a user in the LDAP user directory, then a new account will not be added to the Covata Platform for that account in LDAP (during synchronisation). * Retrieves a list of field information for all LDAP connections configured on the Covata Platform. ## Supported roles and conditions 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) - using the: * `POST` method, when only one organisation has been configured on the Covata Platform. To retrieve information about all configured organisations on the Covata Platform, see [\/api/v1/organisations](/3.5/api/access-service-api-v1-organisations.md). * `GET` method, without any futher conditions. The Covata Platform's resources available to a Covata user meeting the criteria above is determined by the access token submitted in the [header](/3.5/api/access-service-api-v1-ldapconnections.md#access-service-api-v1-ldapconnections-required-headers) 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** - . * **syncFilter** - . * **authFilter** - . * **domain** - . * **accountNameField** - . * **emailField** - . * **userPrincipalNameField** - . * **fullnameField** - . * **statusField** - . * **statusDisabledValue** - . \ **Example (request):** ```json theme={null} { "serverUrl":"ldap://ldap.xy-company.com", "serverTimeout":45000, "managerDN":"cn=server sync,cn=users,dc=xy-company,dc=com", "managerPassword":"password", "baseDN":"ou=users,dc=xy-company,dc=com", "syncFilter":"(&(memberOf=ou=users,dc=xy-company,dc=com)(userPrincipalName=*@xy-company.com))", "authFilter":"userPrincipalName={0}", "domain":"XY-COMPANY", "accountNameField":"sAMAccountName", "emailField":"mail", "userPrincipalNameField":"userPrincipalName", "fullnameField":"name", "statusField":"userAccountControl", "statusDisabledValue":"2" } ``` ## 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: * **items** ( *from GET requests only* ) - . * **id** - . * **serverUrl** - . * **serverTimeout** - . * **baseDN** - . * **authFilter** - . * **managerDN** - . * **managerPassword** - . * **syncFilter** - . * **domain** - . * **enabled** - . * **emailField** - . * **userPrincipalNameField** - . * **statusField** - . * **statusDisabledValue** - . * **accountNameField** - . * **fullnameField** - . * **modifiedAt** - . * **createdAt** - . * **count** ( *from GET requests only* ) - . * **offset** ( *from GET requests only* ) - . \ **Example (response from a GET request):** ```json theme={null} { "items":[ { "id":"1000000", "serverUrl":"ldap://ldap.xy-company.com", "serverTimeout":45000, "baseDN":"ou=users,dc=xy-company,dc=com", "authFilter":"userPrincipalName={0}", "managerDN":"cn=server sync,cn=users,dc=xy-company,dc=com", "managerPassword":"password", "syncFilter":"(&(memberOf=ou=users,dc=xy-company,dc=com)(userPrincipalName=*@xy-company.com))", "domain":"XY-COMPANY", "enabled":true, "emailField":"mail", "userPrincipalNameField":"userPrincipalName", "statusField":"userAccountControl", "statusDisabledValue":"2", "accountNameField":"sAMAccountName", "fullnameField":"name", "modifiedAt":"2016-10-27T00:39:55.604Z", "createdAt":"2016-10-27T00:39:55.604Z" } ], "count":"1", "offset":"0" } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.