Back to Redis

Ldap Mapping

content/operate/rs/7.8/references/rest-api/objects/ldap_mapping.md

latest1.0 KB
Original Source

An API object that represents an [LDAP mapping]({{< relref "/operate/rs/7.8/security/access-control/ldap/map-ldap-groups-to-roles" >}}) between an LDAP group and [roles]({{< relref "/operate/rs/7.8/references/rest-api/objects/role" >}}).

NameType/ValueDescription
uidintegerLDAP mapping's unique ID
account_idintegerSM account ID
action_uidstringAction UID. If it exists, progress can be tracked by the GET /actions/{uid} API (read-only)
bdbs_email_alertscomplex objectUIDs of databases that associated email addresses will receive alerts for
cluster_email_alertsbooleanActivate cluster email alerts for an associated email
dnstringAn LDAP group's distinguished name
emailstringEmail address used for alerts (if set)
email_alertsboolean (default: true)Activate email alerts for an associated email
namestringRole's name
role_uidsarray of integersList of role UIDs associated with the LDAP group