Sign in

v25

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015053126.2 KB
LDAP Mapping

Create a Redis Software LDAP mapping

Create a new Redis Software LDAP mapping.

post/v1/ldap_mappings

Request body

account_idinteger

SM account ID.

bdbs_email_alertsstring[]

UIDs of databases that LDAP mapping users will receive alerts for.

cluster_email_alertsboolean

Activate cluster email alerts for an LDAP mapping.

dnstring required

LDAP group's distinguished name.

emailstring

LDAP mapping's email.

email_alertsboolean

Activate email alerts for an LDAP mapping.

namestring required

LDAP mapping's name.

role_uidsinteger[] required

List of role uids associated with the LDAP mapping.

Example request

{
  "dn": "OU=ops.group,DC=redislabs,DC=com",
  "email": "ops.group@redislabs.com",
  "email_alerts": true,
  "name": "Admins",
  "role_uids": [
    1
  ]
}

Response

LDAP mapping created successfully.

account_idinteger

SM account ID.

bdbs_email_alertsstring[]

UIDs of databases that LDAP mapping users will receive alerts for.

cluster_email_alertsboolean

Activate cluster email alerts for an LDAP mapping.

dnstring required

LDAP group's distinguished name.

emailstring required

LDAP mapping's email.

email_alertsboolean required

Activate email alerts for an LDAP mapping.

namestring required

LDAP mapping's name.

role_uidsinteger[] required

List of role uids associated with the LDAP mapping.

action_uidstring

Action uid. If exists - progress can be tracked by the GET /actions/<uid> API.

uidinteger required

LDAP mapping's unique uid.

Example response

{
  "dn": "OU=ops.group,DC=redislabs,DC=com",
  "email": "ops.group@redislabs.com",
  "email_alerts": true,
  "name": "Admins",
  "role_uids": [
    1
  ],
  "uid": 17
}