Register a service provider

POST

/api/v5/rest/auth/saml2/:centralized_organization_slug/service-providers/

POST

/api/v5/rest/auth/saml2/:centralized_organization_slug/service-providers/

$ curl -X POST https://qa.creha.co/api/v5/rest/auth/saml2/centralized_organization_slug/service-providers/ \
>      -H "Secret-Access: Secret-Access" \
>      -H "Api-Key: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "entity_id": "https://myapp.example.com/saml2",
>   "acs_url": "https://myapp.example.com/saml2/acs",
>   "slo_url": "https://myapp.example.com/saml2/slo",
>   "name_id_format": "email"
> }'

1 {
2   "message": "Service provider registered successfully",
3   "datetime": "2026-03-04T12:00:00",
4   "data": {
5     "id": "1",
6     "entity_id": "https://myapp.example.com/saml2",
7     "acs_url": "https://myapp.example.com/saml2/acs",
8     "name_id_format": "email",
9     "is_active": true,
10     "created_at": "2026-03-04T12:00:00Z",
11     "updated_at": "2026-03-04T12:00:00Z",
12     "saml2_idp_configuration_id": "1",
13     "slo_url": "https://myapp.example.com/saml2/slo"
14   }
15 }

Registers a new SAML2 Service Provider for the organization. Requires the SP’s entity ID and ACS URL. Optionally accepts an SLO URL and a name ID format (defaults to email).

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 Service Provider

acs_urlstringRequired

Assertion Consumer Service URL

slo_urlstringOptional

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