Get LDAP Team Mapping - GET /LDAPTeamMappings

Get details of all LDAP team mapping.

Usage:

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

URL

/cxrestapi/auth/LDAPTeamMappings

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 the LDAP Servers API.
teamId=[integer] – Unique Id of the Team

Success Response:

Code: 200 Success

Error Response:

Code: 400 Bad Request
Code: 401 Unauthorized
Code: 403 Forbidden

Sample Response:

[
  {
    "id": 2,
    "ldapServerId": 1,
    "teamId": 10,
    "ldapGroupDn": "cn=Uruguay,ou=groups,ou=testing,dc=example,dc=com",
    "ldapGroupDisplayName": "Uruguay"
  },
  {
    "id": 15,
    "ldapServerId": 1,
    "teamId": 1,
    "ldapGroupDn": "cn=Chad,ou=groups,ou=testing,dc=example,dc=com",
    "ldapGroupDisplayName": "Chad"
  },
  {
    "id": 16,
    "ldapServerId": 1,
    "teamId": 1,
    "ldapGroupDn": "cn=Cuba,ou=groups,ou=testing,dc=example,dc=com",
    "ldapGroupDisplayName": "Cuba"
  },
  {
    "id": 22,
    "ldapServerId": 1,
    "teamId": 1,
    "ldapGroupDn": "cn=Guam,ou=groups,ou=testing,dc=example,dc=com",
    "ldapGroupDisplayName": "Guam"
  }
]

Notes:

Retrieves details of all LDAP team mapping according to the defined parameters. LDAP Server Id (ldapServerId) is used in the LDAP Servers API, Team Id (teamId) is used in the Teams API and LDAP Group DN (ldapGroupDn) 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!