Delete a SAML Identity Provider - DELETE /SamlIdentityProviders/{id} (v2.0 and up)



Delete a specific SAML identity provider with all related details according to SAML Identity Providers Id. Note that this action permanently deletes all related users.

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

Usage:

  1. GET /SamlIdentityProviders and get details of all SAML identity providers

  2. DELETE /SamlIdentityProviders/{id} and delete the SAML identity provider’s details

URL

/cxrestapi/auth/SamlIdentityProviders/{id}

Method:

DELETE

Media Type (header):

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

Parameters

id=[integer] - SAML identity provider Id

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 SAML identity provider details according to SAML identity provider 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!