Create New SAML Identity Provider - POST /SamlIdentityProviders (v2.0 and up)

Create a new SAML identity provider.

Usage:

1. POST /SamlIdentityProviders and create a new SAML identity provider

2. GET /SamlIdentityProviders and get details of all SAML identity providers, or

3. GET /SamlIdentityProviders/{id} and get details of a specified SAML identity provider

URL

/cxrestapi/auth/SamlIdentityProviders

Method:

POST

Media Type (header):

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

Parameters

Content-type [multipart/form-data]: Specifies the SAML Identity Provider details
CertificateFile=[file] – Certificate file used to verify the SAML assertion
Active=[Boolean] – Whether the SAML identity provider is active (true/false)
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] - Redirects URL when logging-out
ErrorUrl=[string] - Redirects 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: 201 Success

Error Response:

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

Sample Response:

no content

Notes:

Returns the location of the created SAML identity provider in the response header. 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!