SSO Administration

14 Endpunkte. Basis-URL: https://xapi.ambertech.cloud/api/v1

List SAML connections#

GET/organizations/sso/connectionsToken

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/organizations/sso/connections" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a SAML connection#

POST/organizations/sso/connectionsToken

Request-Body`application/jsonCreateSsoConnectionDto`

Name	Typ	Beschreibung
`display_name`Pflicht	`string`	Beispiel: `Microsoft Entra ID`
`idp_entity_id`Pflicht	`string`	IdP Entity ID (the SAML Issuer) Beispiel: `https://sts.windows.net/00000000-0000-0000-0000-000000000000/`
`idp_sso_url`Pflicht	`string`	IdP single sign-on URL Beispiel: `https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/saml2`
`idp_certs`Pflicht	`string[]`	IdP signing certificates as PEM, with or without BEGIN/END lines
`is_enabled`	`boolean`	Standard: `false`
`jit_enabled`	`boolean`	Create accounts and memberships on first SSO login Standard: `false`

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/organizations/sso/connections" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"display_name":"Microsoft Entra ID","idp_entity_id":"https://sts.windows.net/00000000-0000-0000-0000-000000000000/","idp_sso_url":"https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/saml2","idp_certs":[]}'

Update a SAML connection#

PATCH/organizations/sso/connections/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonUpdateSsoConnectionDto`

Name	Typ	Beschreibung
`display_name`	`string`	Beispiel: `Microsoft Entra ID`
`idp_entity_id`	`string`	IdP Entity ID (the SAML Issuer) Beispiel: `https://sts.windows.net/00000000-0000-0000-0000-000000000000/`
`idp_sso_url`	`string`	IdP single sign-on URL Beispiel: `https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/saml2`
`idp_certs`	`string[]`	IdP signing certificates as PEM, with or without BEGIN/END lines
`is_enabled`	`boolean`	Standard: `false`
`jit_enabled`	`boolean`	Create accounts and memberships on first SSO login Standard: `false`

Antworten

200OK

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/organizations/sso/connections/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"display_name":"Microsoft Entra ID","idp_entity_id":"https://sts.windows.net/00000000-0000-0000-0000-000000000000/","idp_sso_url":"https://login.microsoftonline.com/00000000-0000-0000-0000-000000000000/saml2"}'

Delete a SAML connection#

DELETE/organizations/sso/connections/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/organizations/sso/connections/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List SSO email domains#

GET/organizations/sso/domainsToken

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/organizations/sso/domains" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Add an SSO email domain#

POST/organizations/sso/domainsToken

Request-Body`application/jsonAddSsoDomainDto`

Name	Typ	Beschreibung
`domain`Pflicht	`string`	Beispiel: `example.com`
`connection_id`	`object (uuid)`	–

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/organizations/sso/domains" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"domain":"example.com"}'

Bind or unbind a domain to a connection#

PATCH/organizations/sso/domains/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonUpdateSsoDomainDto`

Name	Typ	Beschreibung
`connection_id`Pflicht	`object (uuid)`	Connection allowed to sign in this domain, or null to unbind

Antworten

200OK

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/organizations/sso/domains/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"connection_id":"…"}'

Remove an SSO email domain#

DELETE/organizations/sso/domains/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/organizations/sso/domains/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Verify domain ownership through its DNS TXT record#

POST/organizations/sso/domains/{id}/verifyToken

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/organizations/sso/domains/{id}/verify" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

List SCIM tokens#

GET/organizations/sso/scim-tokensToken

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/organizations/sso/scim-tokens" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a SCIM token (plaintext returned once)#

POST/organizations/sso/scim-tokensToken

Request-Body`application/jsonCreateScimTokenDto`

Name	Typ	Beschreibung
`label`Pflicht	`string`	Beispiel: `Microsoft Entra ID provisioning`

Antworten

201Erstellt

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/organizations/sso/scim-tokens" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"label":"Microsoft Entra ID provisioning"}'

Revoke a SCIM token#

DELETE/organizations/sso/scim-tokens/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200OK

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/organizations/sso/scim-tokens/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Get Require SSO and the SCIM base URL#

GET/organizations/sso/settingsToken

Antworten

200OK

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/organizations/sso/settings" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Switch Require SSO on or off#

PATCH/organizations/sso/settingsToken

Request-Body`application/jsonUpdateSsoSettingsDto`

Name	Typ	Beschreibung
`require_sso`Pflicht	`boolean`	–

Antworten

200OK

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/organizations/sso/settings" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"require_sso":true}'

SSO Administration

List SAML connections#

Antworten

Create a SAML connection#

Request-Bodyapplication/jsonCreateSsoConnectionDto

Antworten

Update a SAML connection#

Parameter

Request-Bodyapplication/jsonUpdateSsoConnectionDto

Antworten

Delete a SAML connection#

Parameter

Antworten

List SSO email domains#

Antworten

Add an SSO email domain#

Request-Bodyapplication/jsonAddSsoDomainDto

Antworten

Bind or unbind a domain to a connection#

Parameter

Request-Bodyapplication/jsonUpdateSsoDomainDto

Antworten

Remove an SSO email domain#

Parameter

Antworten

Verify domain ownership through its DNS TXT record#

Parameter

Antworten

List SCIM tokens#

Antworten

Create a SCIM token (plaintext returned once)#

Request-Bodyapplication/jsonCreateScimTokenDto

Antworten

Revoke a SCIM token#

Parameter

Antworten

Get Require SSO and the SCIM base URL#

Antworten

Switch Require SSO on or off#

Request-Bodyapplication/jsonUpdateSsoSettingsDto

Antworten

Request-Body`application/jsonCreateSsoConnectionDto`

Request-Body`application/jsonUpdateSsoConnectionDto`

Request-Body`application/jsonAddSsoDomainDto`

Request-Body`application/jsonUpdateSsoDomainDto`

Request-Body`application/jsonCreateScimTokenDto`

Request-Body`application/jsonUpdateSsoSettingsDto`