Update LDAP Role Mapping - PUT /LDAPServers/{id}/RoleMappings

Update LDAP role mapping details according to LDAP Server Id.

Usage:

1. GET /LDAPServers and get details of all LDAP Servers
2. GET /LDAPRoleMappings?ldapServerId={id} to get the specific LDAP server mappings
3. PUT /LDAPServers/{id}/RoleMappings and update LDAP role mapping details

URL

/cxrestapi/auth/LDAPServers/{id}/RoleMappings

Method:

PUT

Media Type (header):

Authorization: Bearer <access token value>
Content-Type: application/json;v=1.0

Parameters

Required:

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

editLdapRoleMappingViewModel=[body]: Specifies the LDAP role mapping details to update
roleId=[integer] – Role Id. Role Id (roleId) is retrieved using the Roles API
ldapGroupDn=[string] - LDAP group distinguished name (DN)
ldapGroupDisplayName=[string] - LDAP group display name

Success Response:

Code: 204 Success

Error Response:

Code: 400 Bad request
Code: 401 Unauthorized
Code: 403 Forbidden
Code: 404 Not Found

Sample Response:

no content

Notes:

Updates LDAP role mapping details according to LDAP Server Id. Once the request is successful, it does not return any content. 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!