> For the complete documentation index, see [llms.txt](https://docs.silk.us/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.silk.us/api-reference/endpoints/system-configuration/ldap-servers.md).

# LDAP servers

LDAP servers let users sign in with their directory credentials. You map directory groups to Silk roles, so a user's group membership determines what they can do.

Use these endpoints to connect a directory service, check its status, update its connection settings or group mappings, or remove it.

## GET /system/ldap\_servers

> List LDAP servers

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"LDAP servers","description":"LDAP servers let users sign in with their directory credentials. You map directory groups to Silk roles, so a user's group membership determines what they can do.\n\nUse these endpoints to connect a directory service, check its status, update its connection settings or group mappings, or remove it."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"parameters":{"limit":{"name":"__limit","in":"query","schema":{"type":"integer"},"description":"Caps the number of returned entities. Requires a sort parameter when paging."},"offset":{"name":"__offset","in":"query","schema":{"type":"integer"},"description":"Returns results starting from this offset. Requires a sort parameter when paging."},"sort":{"name":"__sort","in":"query","schema":{"type":"string"},"description":"Comma-separated object properties to sort by."},"sort_order":{"name":"__sort_order","in":"query","schema":{"type":"string","enum":["asc","desc"]},"description":"Sort direction."}},"schemas":{"Collection":{"type":"object","properties":{"hits":{"type":"array","items":{},"description":"The matching objects."},"limit":{"type":"integer","description":"Page size."},"offset":{"type":"integer","description":"Offset of the first returned object."},"total":{"type":"integer","description":"Total number of matching objects."}}},"SystemLdapServers":{"type":"object","properties":{"base_dn":{"type":"string"},"fqdn":{"type":"string"},"group_mapped_to_admin":{"type":"string"},"group_mapped_to_viewer":{"type":"string"},"id":{"type":"integer"},"port":{"type":"integer"},"type":{"type":"string"},"uri":{"type":"string"},"use_ssl":{"type":"boolean"},"user_dn":{"type":"string"}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/system/ldap_servers":{"get":{"tags":["LDAP servers"],"summary":"List LDAP servers","operationId":"listSystemLdapServers","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/sort_order"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Collection"},{"type":"object","properties":{"hits":{"type":"array","items":{"$ref":"#/components/schemas/SystemLdapServers"}}}}]}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## POST /system/ldap\_servers

> Add LDAP server

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"LDAP servers","description":"LDAP servers let users sign in with their directory credentials. You map directory groups to Silk roles, so a user's group membership determines what they can do.\n\nUse these endpoints to connect a directory service, check its status, update its connection settings or group mappings, or remove it."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"schemas":{"SystemLdapServers":{"type":"object","properties":{"base_dn":{"type":"string"},"fqdn":{"type":"string"},"group_mapped_to_admin":{"type":"string"},"group_mapped_to_viewer":{"type":"string"},"id":{"type":"integer"},"port":{"type":"integer"},"type":{"type":"string"},"uri":{"type":"string"},"use_ssl":{"type":"boolean"},"user_dn":{"type":"string"}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/system/ldap_servers":{"post":{"tags":["LDAP servers"],"summary":"Add LDAP server","operationId":"createSystemLdapServers","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemLdapServers"}}}},"default":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Add LDAP server","properties":{"server_type":{"type":"string"},"uri":{"type":"string"},"base_dn":{"type":"string"},"user_dn":{"type":"string"},"users_rdn":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"group_mapped_to_admin":{"type":"string"},"group_mapped_to_viewer":{"type":"string"}},"required":["server_type","uri","base_dn","user_dn","users_rdn","username","password","group_mapped_to_admin","group_mapped_to_viewer"]}}}}}}}}
```

## GET /system/ldap\_servers/{id}

> Get an LDAP server

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"LDAP servers","description":"LDAP servers let users sign in with their directory credentials. You map directory groups to Silk roles, so a user's group membership determines what they can do.\n\nUse these endpoints to connect a directory service, check its status, update its connection settings or group mappings, or remove it."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"schemas":{"SystemLdapServers":{"type":"object","properties":{"base_dn":{"type":"string"},"fqdn":{"type":"string"},"group_mapped_to_admin":{"type":"string"},"group_mapped_to_viewer":{"type":"string"},"id":{"type":"integer"},"port":{"type":"integer"},"type":{"type":"string"},"uri":{"type":"string"},"use_ssl":{"type":"boolean"},"user_dn":{"type":"string"}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/system/ldap_servers/{id}":{"get":{"tags":["LDAP servers"],"summary":"Get an LDAP server","operationId":"getSystemLdapServers","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemLdapServers"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## DELETE /system/ldap\_servers/{id}

> Delete an LDAP server

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"LDAP servers","description":"LDAP servers let users sign in with their directory credentials. You map directory groups to Silk roles, so a user's group membership determines what they can do.\n\nUse these endpoints to connect a directory service, check its status, update its connection settings or group mappings, or remove it."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}}},"paths":{"/system/ldap_servers/{id}":{"delete":{"tags":["LDAP servers"],"summary":"Delete an LDAP server","operationId":"deleteSystemLdapServers","responses":{"204":{"description":"No content"},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## PATCH /system/ldap\_servers/{id}

> Update LDAP server

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"LDAP servers","description":"LDAP servers let users sign in with their directory credentials. You map directory groups to Silk roles, so a user's group membership determines what they can do.\n\nUse these endpoints to connect a directory service, check its status, update its connection settings or group mappings, or remove it."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"schemas":{"SystemLdapServers":{"type":"object","properties":{"base_dn":{"type":"string"},"fqdn":{"type":"string"},"group_mapped_to_admin":{"type":"string"},"group_mapped_to_viewer":{"type":"string"},"id":{"type":"integer"},"port":{"type":"integer"},"type":{"type":"string"},"uri":{"type":"string"},"use_ssl":{"type":"boolean"},"user_dn":{"type":"string"}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/system/ldap_servers/{id}":{"patch":{"tags":["LDAP servers"],"summary":"Update LDAP server","operationId":"updateSystemLdapServers","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Update LDAP server","properties":{"server_type":{"type":"string"},"uri":{"type":"string"},"base_dn":{"type":"string"},"user_dn":{"type":"string"},"users_rdn":{"type":"string"},"username":{"type":"string"},"password":{"type":"string"},"group_mapped_to_admin":{"type":"string"},"group_mapped_to_viewer":{"type":"string"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemLdapServers"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.silk.us/api-reference/endpoints/system-configuration/ldap-servers.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
