SCIM Tokens API
Reference for the SCIM Tokens endpoint group — 6 endpoints.
Generated from the live OpenAPI spec. Re-run _generate_api_reference.py after backend changes.
Authentication#
All endpoints require a Bearer JWT in the Authorization header unless noted otherwise. See Concepts → Tokens and scopes and Reference → OAuth endpoints for how to obtain one.
Endpoints#
GET /api/v1/admin/scim-tokens/#
List Scim Tokens
List SCIM tokens.
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
page |
query | no | integer |
|
per_page |
query | no | integer |
|
tenant_id |
query | no | string | null |
|
authorization |
header | no | string | null |
Responses:
| Status | Body |
|---|---|
200 |
application/json → any |
422 |
application/json → HTTPValidationError |
POST /api/v1/admin/scim-tokens/#
Create Scim Token
Create a new SCIM token.
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
authorization |
header | no | string | null |
Request body:
Required.
application/json→ object
Responses:
| Status | Body |
|---|---|
201 |
application/json → any |
422 |
application/json → HTTPValidationError |
GET /api/v1/admin/scim-tokens/endpoint-info#
Get Scim Endpoint Info
Get SCIM endpoint information for configuration in identity providers.
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
tenant_id |
query | no | string | null |
|
authorization |
header | no | string | null |
Responses:
| Status | Body |
|---|---|
200 |
application/json → any |
422 |
application/json → HTTPValidationError |
DELETE /api/v1/admin/scim-tokens/{token_id}#
Revoke Scim Token
Revoke (soft delete) a SCIM token.
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
token_id |
path | yes | string |
|
authorization |
header | no | string | null |
Responses:
| Status | Body |
|---|---|
204 |
Successful Response |
422 |
application/json → HTTPValidationError |
GET /api/v1/admin/scim-tokens/{token_id}#
Get Scim Token
Get a SCIM token by ID.
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
token_id |
path | yes | string |
|
authorization |
header | no | string | null |
Responses:
| Status | Body |
|---|---|
200 |
application/json → any |
422 |
application/json → HTTPValidationError |
PATCH /api/v1/admin/scim-tokens/{token_id}#
Update Scim Token
Update a SCIM token.
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
token_id |
path | yes | string |
|
authorization |
header | no | string | null |
Request body:
Required.
application/json→ object
Responses:
| Status | Body |
|---|---|
200 |
application/json → any |
422 |
application/json → HTTPValidationError |
Schemas#
Definitions for every type referenced by the endpoints above. Schema-to-schema references on this page link within the page; cross-page references would require visiting the linked page.
HTTPValidationError#
| Field | Type | Required | Description |
|---|---|---|---|
detail |
array of ValidationError |
no |
ValidationError#
| Field | Type | Required | Description |
|---|---|---|---|
loc |
array of string | integer |
yes | |
msg |
string |
yes | |
type |
string |
yes |