Scim
SCIM 2.0 (RFC 7643 / 7644) for the organization's identity provider - Entra ID, Okta, OneLogin and the like - authenticated with the provisioning token an owner minted under `/api/v1/workspace/scim`.
Users are provisioned into, updated in and removed from the organization; Groups are not provisioned.
get
Users List
The organization's members as SCIM users (filter=userName eq "...", startIndex, count).
No authentication
Parameters
| Name | In | Type | Default | Description |
|---|---|---|---|---|
| filter | query | string | null | ||
| startIndex | query | integer | 1 | |
| count | query | integer | 100 |
Responses
| 200 | Successful Response |
| 422 | Validation ErrorHTTPValidationError |
curl -s "$OSR_URL/scim/v2/Users?startIndex=1&count=100"post
Users Create
Provision a person into the organization (userName = e-mail; roles, active, externalId).
No authentication
Responses
| 201 | Successful Response |
curl -s -X POST "$OSR_URL/scim/v2/Users"get
Users Get
No authentication
Parameters
| Name | In | Type | Default | Description |
|---|---|---|---|---|
| user_id(required) | path | string |
Responses
| 200 | Successful Response |
| 422 | Validation ErrorHTTPValidationError |
curl -s "$OSR_URL/scim/v2/Users/<user_id>"put
Users Replace
Replace the user's attributes (name, roles, active).
No authentication
Parameters
| Name | In | Type | Default | Description |
|---|---|---|---|---|
| user_id(required) | path | string |
Responses
| 200 | Successful Response |
| 422 | Validation ErrorHTTPValidationError |
curl -s -X PUT "$OSR_URL/scim/v2/Users/<user_id>"patch
Users Patch
RFC 7644 PatchOp: replace / add of active, name.*, displayName, roles,
externalId.
No authentication
Parameters
| Name | In | Type | Default | Description |
|---|---|---|---|---|
| user_id(required) | path | string |
Responses
| 200 | Successful Response |
| 422 | Validation ErrorHTTPValidationError |
curl -s -X PATCH "$OSR_URL/scim/v2/Users/<user_id>"delete
Users Delete
Deprovision: the membership is removed and the sessions on the workspace ended (the user stays).
No authentication
Parameters
| Name | In | Type | Default | Description |
|---|---|---|---|---|
| user_id(required) | path | string |
Responses
| 204 | Successful Response |
| 422 | Validation ErrorHTTPValidationError |
curl -s -X DELETE "$OSR_URL/scim/v2/Users/<user_id>"Something wrong or out of date on this page? Tell us - the page is named for you, so a one-line note is enough.
Workspaces
Organization workspaces: members, roles, invitations, teams (rosters, leads, tenant bindings), organization SSO (browser sessions only) and the SCIM provisioning token.
Sign-in and sessions
Sign-in with GitHub, Google or an organization identity provider; browser sessions; and CLI sign-in with device codes (`osr login`): the CLI requests a code, the person approves it in the browser, the CLI receives a workspace API key.