Skip to content
Authrim

Create SCIM token

POST
/api/admin/scim-tokens
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/scim-tokens \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "SCIM provisioning token", "expiresInDays": 90 }'

Creates a tenant SCIM bearer token. The plaintext token is returned once and must be stored by the caller.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
description
string
expiresInDays

Days until the token expires. Omitted: the tenant’s default (federation.scim_token_default_expiry, 365 days unless changed). The effective maximum is the tenant’s federation.scim_token_max_expiry converted to whole days (rounded down), at most 365; a larger value is rejected.

integer
>= 1 <= 365
key
additional properties
Example 
{
  "description": "SCIM provisioning token",
  "expiresInDays": 90
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

SCIM token creation response.

Media type application/json
object
token
required
string
tokenHash
required
string
tenantId
required
string
description
required
string
expiresInDays
required
integer
message
required
string
key
additional properties
Example 
{
  "token": "scim_live_generated_token_value",
  "tokenHash": "sha256:abc123",
  "tenantId": "tenant_123",
  "description": "SCIM provisioning token",
  "expiresInDays": 90,
  "message": "Token created successfully. Save this token securely - it will not be shown again."
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}