Cluster LDAP requests

LDAP configuration requests

Method Path Description
GET /v1/cluster/ldap Get LDAP configuration
PUT /v1/cluster/ldap Set/update LDAP configuration
DELETE /v1/cluster/ldap Delete LDAP configuration

Get LDAP configuration

GET /v1/cluster/ldap

Get the LDAP configuration.

Required permissions

Permission name
view_ldap_config

Request

Example HTTP request

GET /cluster/ldap

Request headers

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted media type

Response

Returns an LDAP object.

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

Code Description
200 OK Success

Update LDAP configuration

PUT /v1/cluster/ldap

Set or update the cluster LDAP configuration.

Required permissions

Permission name
config_ldap

Request

Example HTTP request

POST /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

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted media type

Request body

Include an LDAP object with updated fields in the request body.

Response

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

Error codes

Possible error_code values:

Code Description
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.

Status codes

Code Description
200 OK Success, LDAP config has been set.
400 Bad Request Bad or missing configuration parameters.

Delete LDAP configuration

DELETE /v1/cluster/ldap

Clear the LDAP configuration.

Required permissions

Permission name
config_ldap

Request

Example HTTP request

DELETE /cluster/ldap

Request headers

Key Value Description
Host cnm.cluster.fqdn Domain name
Accept application/json Accepted media type

Response

Returns a status code.

Status codes

Code Description
200 OK Success
RATE THIS PAGE
Back to top ↑