Skip to content

Create the account's SCIM connection. The response carries the SCIM base URL and the bearer token; the token is shown ONCE and is never stored or retrievable again, only rotated.

POST
/account/scim/connection
curl --request POST \
--url https://api.siteqwality.com/account/scim/connection \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "display_name": "example", "identity_provider": "example" }'
Media type application/json

Body for POST /account/scim/connection.

object
display_name
required
string
identity_provider

Optional IdP hint, e.g. okta or microsoft-entra.

string | null
Example generated
{
"display_name": "example",
"identity_provider": "example"
}

Connection created; the bearer token is only returned once

Media type application/json

Create / rotate response: carries the bearer token exactly once.

object
connection
required

SCIM connection as returned to the dashboard. Never carries the bearer token; only the last four characters.

object
connection_id
required
string
display_name
required
string
status
required
string
base_url

SCIM base URL the customer pastes into their IdP.

string | null
bearer_token_last_four
string | null
last_rotated_at
string | null format: date-time
created_at
required
string format: date-time
bearer_token
required

Full bearer token. Shown once, never stored, never retrievable again.

string
Example generated
{
"connection": {
"connection_id": "example",
"display_name": "example",
"status": "example",
"base_url": "example",
"bearer_token_last_four": "example",
"last_rotated_at": "2026-04-15T12:00:00Z",
"created_at": "2026-04-15T12:00:00Z"
},
"bearer_token": "example"
}

Invalid display name

Missing or invalid authentication

Caller is not a super admin, or the plan does not include SCIM

A SCIM connection already exists for this account

Internal server error