Platform · Access
Single Sign-On
One connection per directory — SAML 2.0 and OpenID Connect sign people in; OAuth 2.0, WS-Federation, CAS, LDAP and the rest are described — and the email domains each of them answers for, the directory’s MFA and the roles its groups give.
/api/platform/ssoOverview
| Package | Platform |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Platform › Single Sign-On on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
11 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/platform/ssoRead single sign-on
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/sso" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/ssoPost single sign-on
Request body
The keys this action reads (* = required; "one of" lists the only values):
clientSecretResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/sso" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"clientSecret":"value"}'PUT/api/platform/sso/{id}Put single sign-on
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
clientSecretResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/platform/sso/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"clientSecret":"value"}'POST/api/platform/sso/{id}/import-metadataImport metadata
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
xml, urlResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/sso/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/import-metadata" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"xml":"value","url":"value"}'POST/api/platform/sso/{id}/defaultDefault
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/sso/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/default" \
-H "Authorization: Bearer $TOKEN"DELETE/api/platform/sso/{id}Delete single sign-on
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/platform/sso/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/sso/{id}/metadataMetadata
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/sso/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/metadata" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/sso/{id}/domainsDomains
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
domain, includeSubdomainsResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/sso/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/domains" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"domain":"value","includeSubdomains":"value"}'POST/api/platform/sso/domains/{domainId}/verifyDomains verify
Path parameters
| Name | Type | Description |
|---|---|---|
domainId | string (uuid) | The record's domainId, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
verifiedResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/sso/domains/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/verify" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"verified":"value"}'DELETE/api/platform/sso/domains/{domainId}Domains
Path parameters
| Name | Type | Description |
|---|---|---|
domainId | string (uuid) | The record's domainId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/platform/sso/domains/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/sso/discoverDiscover
Request body
The keys this action reads (* = required; "one of" lists the only values):
emailResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/sso/discover" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"email":"value"}'Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Platform › Single Sign-On for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.