{
  "id": "ldap",
  "title": "Cluster LDAP requests",
  "url": "https://redis.io/docs/latest/operate/rs/7.8/references/rest-api/requests/cluster/ldap/",
  "summary": "LDAP configuration requests",
  "content": "\n| Method | Path | Description |\n|--------|------|-------------|\n| [GET](#get-cluster-ldap) | `/v1/cluster/ldap` | Get LDAP configuration |\n| [PUT](#put-cluster-ldap) | `/v1/cluster/ldap` | Set/update LDAP configuration |\n| [DELETE](#delete-cluster-ldap) | `/v1/cluster/ldap` | Delete LDAP configuration |\n\n## Get LDAP configuration {#get-cluster-ldap}\n\n\tGET /v1/cluster/ldap\n\nGet the LDAP configuration.\n\n#### Required permissions\n\n| Permission name |\n|-----------------|\n| [view_ldap_config]() |\n\n### Request {#get-request} \n\n#### Example HTTP request\n\n\tGET /v1/cluster/ldap \n\n#### Request headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n### Response {#get-response} \n\nReturns an [LDAP object]().\n\n#### Example JSON body\n\n```json\n{\n   \"bind_dn\": \"rl_admin\",\n   \"bind_pass\": \"***\",\n   \"ca_cert\": \"\",\n   \"control_plane\": false,\n   \"data_plane\": false,\n   \"dn_group_attr\": \"MemberOf\",\n   \"dn_group_query\": {},\n   \"starttls\": false,\n   \"uris\": [\"ldap://ldap.example.org:636\"],\n   \"user_dn_query\": {},\n   \"user_dn_template\": \"cn=%u, ou=users,dc=example,dc=org\"\n}\n```\n\n### Status codes {#get-status-codes} \n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | Success |\n\n## Update LDAP configuration {#put-cluster-ldap}\n\n\tPUT /v1/cluster/ldap\n\nSet or update the cluster LDAP configuration.\n\n#### Required permissions\n\n| Permission name |\n|-----------------|\n| [config_ldap]() |\n\n### Request {#put-request} \n\n#### Example HTTP request\n\n\tPOST /v1/cluster/ldap \n\n#### Example JSON body\n\n```json\n{\n    \"uris\": [\n       \"ldap://ldap.redislabs.com:389\"\n    ],\n    \"bind_dn\": \"rl_admin\",\n    \"bind_pass\": \"secret\",\n    \"user_dn_template\": \"cn=%u,dc=example,dc=org\",\n    \"dn_group_attr\": \"MemberOf\",\n    \"directory_timeout_s\": 5\n}\n```\n\n#### Request headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n\n#### Request body\n\nInclude an [LDAP object]() with updated fields in the request body.\n\n### Response {#put-response} \n\nReturns a status code. If an error occurs, the response body may include an error code and message with more details.\n\n### Error codes {#put-error-codes} \n\nPossible `error_code` values:\n\n| Code | Description |\n|------|-------------|\n| illegal_fields_combination | An unacceptable combination of fields was specified for the configuration object (e.g.: two mutually-exclusive fields), or a required field is missing.| \n\n### Status codes {#put-status-codes} \n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | Success, LDAP config has been set. |\n| [400 Bad Request](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1) | Bad or missing configuration parameters. |\n\n## Delete LDAP configuration {#delete-cluster-ldap}\n\n\tDELETE /v1/cluster/ldap\n\nClear the LDAP configuration.\n\n#### Required permissions\n\n| Permission name |\n|-----------------|\n| [config_ldap]() |\n\n### Request {#delete-request} \n\n#### Example HTTP request\n\n\tDELETE /v1/cluster/ldap \n\n#### Request headers\n\n| Key | Value | Description |\n|-----|-------|-------------|\n| Host | cnm.cluster.fqdn | Domain name |\n| Accept | application/json | Accepted media type |\n\n### Response {#delete-response} \n\nReturns a status code.\n\n### Status codes {#delete-status-codes} \n\n| Code | Description |\n|------|-------------|\n| [200 OK](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1) | Success |\n",
  "tags": ["docs","operate","rs"],
  "last_updated": "2026-04-01T08:10:08-05:00"
}