Organisations
Read an organisation's SCIM settings
The SCIM base URL, the live token without its value, how many people the provider manages, its groups and their roles, and whether the plan includes SCIM.
GET
/orgs/{org}/scimTL;DR
| Question | Answer |
|---|---|
| What does it do? | Read an organisation's SCIM settings. |
| What does it take? | org in the path. |
| What does it return? | Status 200 with a body of type ScimSettings. |
| What can go wrong? | 401 not signed in; 403 a member or a reader (orgs.forbidden), a plan without scim (plan.sso_not_included), or the request came from an origin that may not make changes; 404 no such organisation, or the caller is not a member of it; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
The SCIM base URL, the live token without its value, how many people the provider manages, its groups and their roles, and whether the plan includes SCIM. The owner and admins.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The settings. | ScimSettings |
| 401 | Not signed in. | ErrorResponse |
| 403 | A member or a reader (orgs.forbidden), a plan without SCIM (plan.sso_not_included), or the request came from an origin that may not make changes. | ErrorResponse |
| 404 | No such organisation, or the caller is not a member of it. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type ScimSettings.
| Field | Type | Required | Description |
|---|---|---|---|
available | boolean | yes | Whether the organisation's plan includes SCIM (Enterprise). |
baseUrl | string | yes | The SCIM base URL to give the identity provider. |
token | ScimTokenView | yes | |
token.prefix | string | yes | The first characters of the token, to tell it apart. |
token.createdAt | integer | yes | |
token.lastUsedAt | integer | null | yes | When the provider last used it, to the minute. Null until it has. |
users | integer | yes | How many people the provider manages here, active or not. |
groups | ScimGroupView[] | yes | |
groups[].id | string | yes | |
groups[].displayName | string | yes | |
groups[].role | "admin" | "member" | "reader" | null | yes | The role the group gives its members, or null when it gives none. |
groups[].members | integer | yes |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |