Platform · Reachable by link
Identity Providers (raw)
The connection table behind Single Sign-On, as rows. Edit connections under Access → Single Sign-On, where the protocol decides which fields you are asked for.
/api/platform/identity-providersPublished as /api/v1/identity-providersDownload specification (OpenAPI 3.1) Screen: Identity Providers (raw)
Overview
| 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 › Identity Providers (raw) 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. |
| Table | platform.identity_providers · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/platform/identity-providersList identity providers (raw)
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"protocol": "text",
"vendor": "text",
"issuer": "text",
"metadata_url": "https://example.com",
"client_id": "text",
"client_secret_cipher": "text",
"scopes": [],
"attribute_map": {},
"default_role_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"auto_provision": true,
"is_enabled": true
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/platform/identity-providers?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/identity-providers/{id}Read one identity providers
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"protocol": "text",
"vendor": "text",
"issuer": "text",
"metadata_url": "https://example.com",
"client_id": "text",
"client_secret_cipher": "text",
"scopes": [],
"attribute_map": {},
"default_role_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"auto_provision": true,
"is_enabled": true
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/platform/identity-providers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/identity-providersCreate a identity providers
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Provider code |
name | text | Yes | Name |
protocol | text | No | Protocol |
vendor | text | No | Vendor — e.g. Okta, Microsoft Entra ID, Google Workspace |
issuer | text | No | Issuer / entity ID |
metadata_url | text | No | Metadata URL |
client_id | text | No | Client ID |
scopes | _text | No | Scopes |
attribute_map | jsonb | No | Attribute map — Which claim becomes which field, e.g. {"email":"mail","full_name":"displayName"} |
default_role_id | uuid | No | Default role — Not given by a directory sign-in: somebody it creates holds Help & Support only until an administrator gives them a role. |
auto_provision | boolean | No | Create a sign-in for new people (Help & Support only) |
is_enabled | boolean | No | Enabled |
Sample body
{
"code": "COD-000001",
"name": "Example",
"protocol": "text",
"vendor": "text",
"issuer": "text",
"metadata_url": "https://example.com"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"protocol": "text",
"vendor": "text",
"issuer": "text",
"metadata_url": "https://example.com",
"client_id": "text",
"client_secret_cipher": "text",
"scopes": [],
"attribute_map": {},
"default_role_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"auto_provision": true,
"is_enabled": true
}Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/identity-providers" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example","protocol":"text","vendor":"text","issuer":"text","metadata_url":"https://example.com"}'PUT/api/platform/identity-providers/{id}Change a identity providers
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
code | text | Yes | Provider code |
name | text | Yes | Name |
protocol | text | No | Protocol |
vendor | text | No | Vendor — e.g. Okta, Microsoft Entra ID, Google Workspace |
issuer | text | No | Issuer / entity ID |
metadata_url | text | No | Metadata URL |
client_id | text | No | Client ID |
scopes | _text | No | Scopes |
attribute_map | jsonb | No | Attribute map — Which claim becomes which field, e.g. {"email":"mail","full_name":"displayName"} |
default_role_id | uuid | No | Default role — Not given by a directory sign-in: somebody it creates holds Help & Support only until an administrator gives them a role. |
auto_provision | boolean | No | Create a sign-in for new people (Help & Support only) |
is_enabled | boolean | No | Enabled |
Sample body
{
"code": "COD-000001",
"name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"code": "COD-000001",
"name": "Example",
"protocol": "text",
"vendor": "text",
"issuer": "text",
"metadata_url": "https://example.com",
"client_id": "text",
"client_secret_cipher": "text",
"scopes": [],
"attribute_map": {},
"default_role_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"auto_provision": true,
"is_enabled": true
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/platform/identity-providers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"COD-000001","name":"Example"}'DELETE/api/platform/identity-providers/{id}Delete a identity providers
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/platform/identity-providers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/identity-providers/{id}/copyCopy
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):
overrides, preview, withLinesResponse
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/identity-providers/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a identity providers, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
code | text | read, write | Provider code |
name | text | read, write | Name |
protocol | text | read, write | Protocol |
vendor | text | read, write | Vendor — e.g. Okta, Microsoft Entra ID, Google Workspace |
issuer | text | read, write | Issuer / entity ID |
metadata_url | text | read, write | Metadata URL |
client_id | text | read, write | Client ID |
client_secret_cipher | bytea | read only | Client secret cipher |
scopes | _text | read, write | Scopes |
attribute_map | jsonb | read, write | Attribute map — Which claim becomes which field, e.g. {"email":"mail","full_name":"displayName"} |
default_role_id | uuid | read, write | Default role — Not given by a directory sign-in: somebody it creates holds Help & Support only until an administrator gives them a role. |
auto_provision | boolean | read, write | Create a sign-in for new people (Help & Support only) |
is_enabled | boolean | read, write | Enabled |
org_unit_id | uuid | read only | Org unit id |
sso_url | text | read only | Sso url |
slo_url | text | read only | Slo url |
acs_url | text | read only | Acs url |
sp_entity_id | text | read only | Sp entity id |
authorize_url | text | read only | Authorize url |
token_url | text | read only | Token url |
userinfo_url | text | read only | Userinfo url |
jwks_url | text | read only | Jwks url |
redirect_uri | text | read only | Redirect uri |
certificate | text | read only | Certificate |
sign_request | boolean | read only | Sign request |
ldap_url | text | read only | Ldap url |
ldap_base_dn | text | read only | Ldap base dn |
ldap_bind_dn | text | read only | Ldap bind dn |
ldap_user_filter | text | read only | Ldap user filter |
settings | jsonb | read only | Settings |
button_label | text | read only | Button label |
sort_order | integer | read only | Sort order |
is_default | boolean | read only | Is default |
require_verified_domain | boolean | read only | Require verified domain |
created_at | timestamp with time zone | read only | Created at |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
created_by | uuid | read only | Created by |
name_id_format | text | read only | Name id format |
idp_initiated | boolean | read only | Idp initiated |
want_encrypted | boolean | read only | Want encrypted |
sp_private_key_cipher | bytea | read only | Sp private key cipher |
sp_certificate | text | read only | Sp certificate |
role_map | jsonb | read only | Role map |
slo_enabled | boolean | read only | Slo enabled |
clock_skew_seconds | integer | read only | Clock skew seconds |
mfa_mode | text | read only | Mfa mode |
mfa_claims | _text | read only | Mfa claims |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
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 › Identity Providers (raw) 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.