REredis
LDAP Mapping

Update a Redis Software LDAP mapping

Changed on

Update an existing LDAP mapping by unique ID.

put/v1/ldap_mappings/{uid}

Request

  • Base URL
    https://localhost:9443
  • URL
    https://localhost:9443/v1/ldap_mappings/{uid}
  • Auth
    API key in header r-auth-user

Path parameters

uidinteger required

The LDAP mapping unique ID.

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

LDAP group's distinguished name.

emailstring

LDAP mapping's email.

email_alertsboolean

Activate email alerts for an LDAP mapping.

namestring

LDAP mapping's name.

role_uidsinteger[]

List of role uids associated with the LDAP mapping.

Response

LDAP mapping updated 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
}

Changes