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

Update an existing SAML identity provider’s details according to SAML Identity Provider Id.

Usage:

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

2. PUT /SamlIdentityProviders/{id} and update the SAML identity provider’s details

URL

/cxrestapi/auth/SamlIdentityProviders/{id}

Method:

PUT

Media Type (header):

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

Parameters

id=[integer] - SAML identity provider Id

Content-type [multipart/form-data]: Specifies the SAML Identity Provider details
CertificateFile=[file] – Certificate file used to verify the SAML assertion
Active=[Boolean] - SAML identity provider state
Name=[string] - SAML identity provider display name
Issuer=[string] - Issuer of the SAML assertion
LoginUrl=[string] - SAML identity provider single sign-on URL
LogoutUrl=[string] - Redirect URL when logging-out
ErrorUrl=[string] - Redirect URL on error
SignAuthnRequest=[Boolean] – Whether the service provider should sign authentication requests to this identity provider (true/false)
AuthnRequestBinding=[string] – Authentication request binding (HTTP-Redirect or HTTP-Post)
IsManualManagement=[Boolean] – Whether role and group management is done manually (default) or controlled via the SAML assertion (not manual)
DefaultTeamId=[integer] - Default team Id
DefaultRoleId=[ineger] - Default role 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:

Updates 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 us. We appreciate your feedback!