Delete LDAP Server – DELETE /LDAPServers/{id}



Delete an LDAP Server according to LDAP Server Id. Note that this action permanently deletes all related users.

The ‘Manage Authentication Providers’ permission is required to execute this API.

Usage:

  1. GET /LDAPServers and get details of all LDAP Servers
  2. DELETE /LDAPServers/{id} and delete an LDAP Server

URL

/cxrestapi/auth/LDAPServers/{id}

Method:

DELETE

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.

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:

Deletes the LDAP Server according to the 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 usWe appreciate your feedback!