Register a trusted IDP

POST

/api/v5/rest/auth/saml2/sp/:centralized_organization_slug/trusted-idps/

POST

/api/v5/rest/auth/saml2/sp/:centralized_organization_slug/trusted-idps/

$ curl -X POST https://qa.creha.co/api/v5/rest/auth/saml2/sp/centralized_organization_slug/trusted-idps/ \
>      -H "Secret-Access: Secret-Access" \
>      -H "Api-Key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "entity_id": "https://idp.intelexion.com/saml2",
>   "sso_url": "https://idp.intelexion.com/saml2/sso",
>   "certificate": "-----BEGIN CERTIFICATE-----\nMIICpDCCAYwCCQD...\n-----END CERTIFICATE-----\n",
>   "slo_url": "https://idp.intelexion.com/saml2/slo",
>   "name_id_format": "email"
> }'

1 {
2   "message": "Trusted IDP registered successfully",
3   "datetime": "2026-03-05T12:00:00",
4   "data": {
5     "id": "1",
6     "entity_id": "https://idp.intelexion.com/saml2",
7     "sso_url": "https://idp.intelexion.com/saml2/sso",
8     "name_id_format": "email",
9     "is_active": true,
10     "created_at": "2026-03-05T12:00:00Z",
11     "updated_at": "2026-03-05T12:00:00Z",
12     "saml2_sp_configuration_id": "1",
13     "slo_url": "https://idp.intelexion.com/saml2/slo"
14   }
15 }

Registers an external Identity Provider as trusted for the organization. Requires the IDP's entity ID, SSO URL and signing certificate in PEM format.

Authentication

Api-Keystring

API key of the organization. Always sent together with the Secret-Access header.

Path parameters

centralized_organization_slugstringRequired

Request

This endpoint expects an object.

entity_idstringRequired

Entity ID URI of the external IDP

sso_urlstringRequired

IDP SSO URL

certificatestringRequired

IDP signing certificate in PEM format

slo_urlstringOptional

IDP Single Logout URL

name_id_formatenumOptionalDefaults to email

Name ID format

Response

Successful Response

messagestring

Message of the response

datetimestring

Datetime of the API in ISO Format

dataobjectOptional

Errors

400

Bad Request Error

409

Conflict Error

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Request

Response

Errors