Ldap

Get LDAP configuration {#get-cluster-ldap}

GET /v1/cluster/ldap

Get the LDAP configuration.

Required permissions

Request {#get-request}

Example HTTP request

GET /v1/cluster/ldap 

Request headers

Response {#get-response}

Returns an [LDAP object]({{< relref "/operate/rs/7.8/references/rest-api/objects/ldap" >}}).

Example JSON body

{
   "bind_dn": "rl_admin",
   "bind_pass": "***",
   "ca_cert": "",
   "control_plane": false,
   "data_plane": false,
   "dn_group_attr": "MemberOf",
   "dn_group_query": {},
   "starttls": false,
   "uris": ["ldap://ldap.example.org:636"],
   "user_dn_query": {},
   "user_dn_template": "cn=%u, ou=users,dc=example,dc=org"
}

Status codes {#get-status-codes}

Update LDAP configuration {#put-cluster-ldap}

PUT /v1/cluster/ldap

Set or update the cluster LDAP configuration.

Required permissions

Request {#put-request}

Example HTTP request

POST /v1/cluster/ldap 

Example JSON body

{
    "uris": [
       "ldap://ldap.redislabs.com:389"
    ],
    "bind_dn": "rl_admin",
    "bind_pass": "secret",
    "user_dn_template": "cn=%u,dc=example,dc=org",
    "dn_group_attr": "MemberOf",
    "directory_timeout_s": 5
}

Request headers

Request body

Include an [LDAP object]({{< relref "/operate/rs/7.8/references/rest-api/objects/ldap" >}}) with updated fields in the request body.

Response {#put-response}

Returns a status code. If an error occurs, the response body may include an error code and message with more details.

Error codes {#put-error-codes}

Possible error_code values:

Status codes {#put-status-codes}

Delete LDAP configuration {#delete-cluster-ldap}

DELETE /v1/cluster/ldap

Clear the LDAP configuration.

Required permissions

Request {#delete-request}

Example HTTP request

DELETE /v1/cluster/ldap 

Request headers

Response {#delete-response}

Returns a status code.

Status codes {#delete-status-codes}