Get All LDAP Role Mapping - GET /LDAPRoleMappings

Get details of all LDAP role mapping.

Usage:

1. GET /LDAPServers and get details of all LDAP Servers
2. GET /LDAPRoleMappings?ldapServerId={id} and get the specific LDAP role mapping

URL

/cxrestapi/auth/LDAPRoleMappings

Method:

GET

Media Type (header):

Authorization: Bearer <access token value>
Accept: application/json;v=1.0

Parameters

Optional:

ldapServerId=[integer] - Unique Id of the LDAP Server. LDAP Server Id (ldapServerId) is retrieved using LDAP Servers API

Success Response:

Code: 200 Success

Error Response:

Code: 401 Unauthorized
Code: 403 Forbidden

Sample Response:

[
  {
    "id": 1,
    "ldapServerId": 1,
    "roleId": 3,
    "ldapGroupDn": "CN=sales,OU=Groups,DC=domain,DC=com",
    "ldapGroupDisplayName": sales
  },
  {
    "id": 2,
    "ldapServerId": 1,
    "roleId": 1,
    "ldapGroupDn": "CN=marketing,OU=Groups,DC=domain,DC=com",
    "ldapGroupDisplayName": marketing
  }
]

Notes:

Retrieves details of all LDAP role mapping. LDAP Server Id (ldapServerId) result is used in the LDAP Servers API, Role Id (roleId) result is used in the Roles API and LDAP Group DN (ldapGroupDn) results is used in the LDAP Servers API. If the request fails, it returns an error response.

Send Documentation Feedback - If you have comments about this documentation, you can contact the documentation team by sending your feedback to us. We appreciate your feedback!