TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/platform/identity-providersPublished as /api/v1/identity-providers

Download specification (OpenAPI 3.1) Screen: Identity Providers (raw)

Overview

PackagePlatform
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tableplatform.identity_providers · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
codetextYesProvider code
nametextYesName
protocoltextNoProtocol
vendortextNoVendor — e.g. Okta, Microsoft Entra ID, Google Workspace
issuertextNoIssuer / entity ID
metadata_urltextNoMetadata URL
client_idtextNoClient ID
scopes_textNoScopes
attribute_mapjsonbNoAttribute map — Which claim becomes which field, e.g. {"email":"mail","full_name":"displayName"}
default_role_iduuidNoDefault role — Not given by a directory sign-in: somebody it creates holds Help & Support only until an administrator gives them a role.
auto_provisionbooleanNoCreate a sign-in for new people (Help & Support only)
is_enabledbooleanNoEnabled

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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesProvider code
nametextYesName
protocoltextNoProtocol
vendortextNoVendor — e.g. Okta, Microsoft Entra ID, Google Workspace
issuertextNoIssuer / entity ID
metadata_urltextNoMetadata URL
client_idtextNoClient ID
scopes_textNoScopes
attribute_mapjsonbNoAttribute map — Which claim becomes which field, e.g. {"email":"mail","full_name":"displayName"}
default_role_iduuidNoDefault role — Not given by a directory sign-in: somebody it creates holds Help & Support only until an administrator gives them a role.
auto_provisionbooleanNoCreate a sign-in for new people (Help & Support only)
is_enabledbooleanNoEnabled

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

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/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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
codetextread, writeProvider code
nametextread, writeName
protocoltextread, writeProtocol
vendortextread, writeVendor — e.g. Okta, Microsoft Entra ID, Google Workspace
issuertextread, writeIssuer / entity ID
metadata_urltextread, writeMetadata URL
client_idtextread, writeClient ID
client_secret_cipherbytearead onlyClient secret cipher
scopes_textread, writeScopes
attribute_mapjsonbread, writeAttribute map — Which claim becomes which field, e.g. {"email":"mail","full_name":"displayName"}
default_role_iduuidread, writeDefault role — Not given by a directory sign-in: somebody it creates holds Help & Support only until an administrator gives them a role.
auto_provisionbooleanread, writeCreate a sign-in for new people (Help & Support only)
is_enabledbooleanread, writeEnabled
org_unit_iduuidread onlyOrg unit id
sso_urltextread onlySso url
slo_urltextread onlySlo url
acs_urltextread onlyAcs url
sp_entity_idtextread onlySp entity id
authorize_urltextread onlyAuthorize url
token_urltextread onlyToken url
userinfo_urltextread onlyUserinfo url
jwks_urltextread onlyJwks url
redirect_uritextread onlyRedirect uri
certificatetextread onlyCertificate
sign_requestbooleanread onlySign request
ldap_urltextread onlyLdap url
ldap_base_dntextread onlyLdap base dn
ldap_bind_dntextread onlyLdap bind dn
ldap_user_filtertextread onlyLdap user filter
settingsjsonbread onlySettings
button_labeltextread onlyButton label
sort_orderintegerread onlySort order
is_defaultbooleanread onlyIs default
require_verified_domainbooleanread onlyRequire verified domain
created_attimestamp with time zoneread onlyCreated at
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by
created_byuuidread onlyCreated by
name_id_formattextread onlyName id format
idp_initiatedbooleanread onlyIdp initiated
want_encryptedbooleanread onlyWant encrypted
sp_private_key_cipherbytearead onlySp private key cipher
sp_certificatetextread onlySp certificate
role_mapjsonbread onlyRole map
slo_enabledbooleanread onlySlo enabled
clock_skew_secondsintegerread onlyClock skew seconds
mfa_modetextread onlyMfa mode
mfa_claims_textread onlyMfa claims
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Platform › Identity Providers (raw) for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.