Get All SAML Identity Providers - GET /SamlIdentityProviders (v2.0 and up)



Get details of all SAML identity providers.

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

Usage:

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

  2. PUT /SamlIdentityProviders/{id} and update SAML Identity Provider details

URL

/cxrestapi/auth/SamlIdentityProviders

Method:

GET

Media Type (header):

Authorization: Bearer <access token value>
Accept: application/json;v=1.0

Parameters

None

Success Response:

Code: 200 Success

Error Response:

Code: 401 Unauthorized
Code: 403 Forbidden

Sample Response:

[
  {
    "id": 0,
    "certificateFileName": "string",
    "certificateSubject": "string",
    "active": true,
    "name": "string",
    "issuer": "string",
    "loginUrl": "string",
    "logoutUrl": "string",
    "errorUrl": "string",
    "signAuthnRequest": true,
    "authnRequestBinding": "string",
    "isManualManagement": true,
    "defaultTeamId": 0,
    "defaultRoleId": 0
  }
]

Notes:

Retrieves details of all SAML identity providers. Default Team Id (defaultTeamId) is used in the Teams API and Default Role Id (defaultRoleId) is used in the Roles 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 usWe appreciate your feedback!