S C I M · Mojo Up Docs

What the SCIM service supports

GET/scim/v2/ServiceProviderConfig

Mojo Up AI Cloud only. The SCIM 2.0 service provider configuration (RFC 7643): patch, filter and the bearer-token authentication supported; bulk, sort, ETags and password changes are not. Every SCIM route takes the team's SCIM token as Authorization: Bearer aioe_sc_…, and answers in application/scim+json.

Authorization

scimToken

AuthorizationBearer <token>

A team's SCIM token (aioe_sc_…), made by an owner under the team's single sign-on settings and given to the identity provider. It names its team, so every SCIM request acts on that team only.

In: header

Response Body

`application/json`

`application/scim+json`

curl -X GET "https://example.com/scim/v2/ServiceProviderConfig"

{}

Resource types

GET/scim/v2/ResourceTypes

The resource types served: User and Group.

Authorization

scimToken

AuthorizationBearer <token>

A team's SCIM token (aioe_sc_…), made by an owner under the team's single sign-on settings and given to the identity provider. It names its team, so every SCIM request acts on that team only.

In: header

Response Body

`application/json`

`application/scim+json`

curl -X GET "https://example.com/scim/v2/ResourceTypes"

{}

One resource type

GET/scim/v2/ResourceTypes/{id}

Authorization

scimToken

AuthorizationBearer <token>

A team's SCIM token (aioe_sc_…), made by an owner under the team's single sign-on settings and given to the identity provider. It names its team, so every SCIM request acts on that team only.

In: header

Path Parameters

id*string

User or Group.

Response Body

`application/json`

`application/scim+json`

curl -X GET "https://example.com/scim/v2/ResourceTypes/string"

{}

Schemas

GET/scim/v2/Schemas

The schemas of the user and group resources the service accepts.

Authorization

scimToken

AuthorizationBearer <token>

A team's SCIM token (aioe_sc_…), made by an owner under the team's single sign-on settings and given to the identity provider. It names its team, so every SCIM request acts on that team only.

In: header

Response Body

`application/json`

`application/scim+json`

curl -X GET "https://example.com/scim/v2/Schemas"

{}

One schema

GET/scim/v2/Schemas/{id}

Authorization

scimToken

AuthorizationBearer <token>

A team's SCIM token (aioe_sc_…), made by an owner under the team's single sign-on settings and given to the identity provider. It names its team, so every SCIM request acts on that team only.

In: header

Path Parameters

id*string

The schema's URN.

Response Body

`application/json`

`application/scim+json`

curl -X GET "https://example.com/scim/v2/Schemas/string"

{}

List users

GET/scim/v2/Users

The people the identity provider has provisioned into the team. Filters are attr op value with eq, ne, co, sw, ew and pr, joined by and; userName compares without regard to case. or, not and parentheses answer invalidFilter.

Authorization

scimToken

AuthorizationBearer <token>

A team's SCIM token (aioe_sc_…), made by an owner under the team's single sign-on settings and given to the identity provider. It names its team, so every SCIM request acts on that team only.

In: header

Query Parameters

filter?string

A SCIM filter, for example userName eq "dana@example.com.au".

startIndex?integer

Range1 <= value

Default1

count?integer

At most 200.

Range0 <= value <= 200

Response Body

`application/json`

`application/scim+json`

curl -X GET "https://example.com/scim/v2/Users"

{}

Provision a user

POST/scim/v2/Users

Adds a person to the team. Their address (the primary email, else the first, else a userName that is an address) must be in one of the team's verified domains. A person who already proved the address is that person; otherwise an account is made that signs in through the team's provider. active: true makes them a member, within the team's seats and plan quota.

Authorization

scimToken

AuthorizationBearer <token>

A team's SCIM token (aioe_sc_…), made by an owner under the team's single sign-on settings and given to the identity provider. It names its team, so every SCIM request acts on that team only.

In: header

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

A SCIM 2.0 resource or list response (schemas, then the resource's attributes, or totalResults, startIndex, itemsPerPage and Resources).

Response Body

`application/json`

`application/scim+json`

curl -X POST "https://example.com/scim/v2/Users" \  -H "Content-Type: application/json" \  -d '{}'

{}

Get a user

GET/scim/v2/Users/{id}

Authorization

scimToken

AuthorizationBearer <token>

A team's SCIM token (aioe_sc_…), made by an owner under the team's single sign-on settings and given to the identity provider. It names its team, so every SCIM request acts on that team only.

In: header

Path Parameters

id*string

The SCIM user id.

Response Body

`application/json`

`application/scim+json`

curl -X GET "https://example.com/scim/v2/Users/string"

{}

Change a user

PATCH/scim/v2/Users/{id}

A SCIM PatchOp. add, replace and remove (any case) work on active, userName, externalId, displayName, name and its parts, emails and emails[type eq "work"].value. Booleans may be strings ("False", as Entra sends). An operation without a path takes an object of attributes.

Authorization

scimToken

AuthorizationBearer <token>

A team's SCIM token (aioe_sc_…), made by an owner under the team's single sign-on settings and given to the identity provider. It names its team, so every SCIM request acts on that team only.

In: header

Path Parameters

id*string

The SCIM user id.

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

A SCIM 2.0 resource or list response (schemas, then the resource's attributes, or totalResults, startIndex, itemsPerPage and Resources).

Response Body

`application/json`

`application/scim+json`

curl -X PATCH "https://example.com/scim/v2/Users/string" \  -H "Content-Type: application/json" \  -d '{}'

{}

Remove a user

DELETE/scim/v2/Users/{id}

Takes the person out of the team as if an owner removed them (their desktops, roles, project places and work claims go with them) and signs them out of Cloud everywhere. The team's last owner is never removed this way (409). active: false does the same.

Authorization

scimToken

AuthorizationBearer <token>

A team's SCIM token (aioe_sc_…), made by an owner under the team's single sign-on settings and given to the identity provider. It names its team, so every SCIM request acts on that team only.

In: header

Path Parameters

id*string

The SCIM user id.

Response Body

`application/scim+json`

curl -X DELETE "https://example.com/scim/v2/Users/string"

Empty

Replace a user

PUT/scim/v2/Users/{id}

Authorization

scimToken

AuthorizationBearer <token>

A team's SCIM token (aioe_sc_…), made by an owner under the team's single sign-on settings and given to the identity provider. It names its team, so every SCIM request acts on that team only.

In: header

Path Parameters

id*string

The SCIM user id.

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

A SCIM 2.0 resource or list response (schemas, then the resource's attributes, or totalResults, startIndex, itemsPerPage and Resources).

Response Body

`application/json`

`application/scim+json`

curl -X PUT "https://example.com/scim/v2/Users/string" \  -H "Content-Type: application/json" \  -d '{}'

{}

List groups

GET/scim/v2/Groups

Groups from the identity provider. Members of the owners' group (owners unless an owner names another) are owners of the team; members of any other group are members. excludedAttributes=members leaves the member lists out.

Authorization

scimToken

AuthorizationBearer <token>

A team's SCIM token (aioe_sc_…), made by an owner under the team's single sign-on settings and given to the identity provider. It names its team, so every SCIM request acts on that team only.

In: header

Query Parameters

filter?string

A SCIM filter, for example userName eq "dana@example.com.au".

startIndex?integer

Range1 <= value

Default1

count?integer

At most 200.

Range0 <= value <= 200

excludedAttributes?"members"

Value in

"members"

Response Body

`application/json`

`application/scim+json`

curl -X GET "https://example.com/scim/v2/Groups"

{}

Create a group

POST/scim/v2/Groups

Authorization

scimToken

AuthorizationBearer <token>

A team's SCIM token (aioe_sc_…), made by an owner under the team's single sign-on settings and given to the identity provider. It names its team, so every SCIM request acts on that team only.

In: header

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

A SCIM 2.0 resource or list response (schemas, then the resource's attributes, or totalResults, startIndex, itemsPerPage and Resources).

Response Body

`application/json`

`application/scim+json`

curl -X POST "https://example.com/scim/v2/Groups" \  -H "Content-Type: application/json" \  -d '{}'

{}

Get a group

GET/scim/v2/Groups/{id}

Authorization

scimToken

AuthorizationBearer <token>

A team's SCIM token (aioe_sc_…), made by an owner under the team's single sign-on settings and given to the identity provider. It names its team, so every SCIM request acts on that team only.

In: header

Path Parameters

id*string

The SCIM group id.

Response Body

`application/json`

`application/scim+json`

curl -X GET "https://example.com/scim/v2/Groups/string"

{}

Change a group

PATCH/scim/v2/Groups/{id}

A SCIM PatchOp on displayName, externalId, members and members[value eq "<id>"]. A change that would leave the team without an owner is refused.

Authorization

scimToken

AuthorizationBearer <token>

A team's SCIM token (aioe_sc_…), made by an owner under the team's single sign-on settings and given to the identity provider. It names its team, so every SCIM request acts on that team only.

In: header

Path Parameters

id*string

The SCIM group id.

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

A SCIM 2.0 resource or list response (schemas, then the resource's attributes, or totalResults, startIndex, itemsPerPage and Resources).

Response Body

`application/json`

`application/scim+json`

curl -X PATCH "https://example.com/scim/v2/Groups/string" \  -H "Content-Type: application/json" \  -d '{}'

{}

Delete a group

DELETE/scim/v2/Groups/{id}

Authorization

scimToken

AuthorizationBearer <token>

A team's SCIM token (aioe_sc_…), made by an owner under the team's single sign-on settings and given to the identity provider. It names its team, so every SCIM request acts on that team only.

In: header

Path Parameters

id*string

The SCIM group id.

Response Body

`application/scim+json`

curl -X DELETE "https://example.com/scim/v2/Groups/string"

Empty

Replace a group

PUT/scim/v2/Groups/{id}

Authorization

scimToken

AuthorizationBearer <token>

A team's SCIM token (aioe_sc_…), made by an owner under the team's single sign-on settings and given to the identity provider. It names its team, so every SCIM request acts on that team only.

In: header

Path Parameters

id*string

The SCIM group id.

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

A SCIM 2.0 resource or list response (schemas, then the resource's attributes, or totalResults, startIndex, itemsPerPage and Resources).

Response Body

`application/json`

`application/scim+json`

curl -X PUT "https://example.com/scim/v2/Groups/string" \  -H "Content-Type: application/json" \  -d '{}'

{}

What the SCIM service supportsCopy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

401application/scim+json

402application/scim+json

Resource typesCopy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

401application/scim+json

402application/scim+json

One resource typeCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

401application/scim+json

402application/scim+json

404application/scim+json

SchemasCopy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

401application/scim+json

402application/scim+json

One schemaCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

401application/scim+json

402application/scim+json

404application/scim+json

List usersCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/scim+json

401application/scim+json

402application/scim+json

429application/scim+json

Provision a userCopy Anchor Link

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

201application/json

400application/scim+json

401application/scim+json

402application/scim+json

403application/scim+json

409application/scim+json

429application/scim+json

Get a userCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

401application/scim+json

402application/scim+json

404application/scim+json

Change a userCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/scim+json

401application/scim+json

402application/scim+json

403application/scim+json

404application/scim+json

409application/scim+json

Remove a userCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

204

401application/scim+json

What the SCIM service supports

Authorization

Response Body

`application/json`

`application/scim+json`

`application/scim+json`

Resource types

Authorization

Response Body

`application/json`

`application/scim+json`

`application/scim+json`

One resource type

Authorization

Path Parameters

Response Body

`application/json`

`application/scim+json`

`application/scim+json`

`application/scim+json`

Schemas

Authorization

Response Body

`application/json`

`application/scim+json`

`application/scim+json`

One schema

Authorization

Path Parameters

Response Body

`application/json`

`application/scim+json`

`application/scim+json`

`application/scim+json`

List users

Authorization

Query Parameters

Response Body

`application/json`

`application/scim+json`

`application/scim+json`

`application/scim+json`

`application/scim+json`

Provision a user

Authorization

Request Body

Response Body

`application/json`

`application/scim+json`

`application/scim+json`

`application/scim+json`

`application/scim+json`

`application/scim+json`

`application/scim+json`

Get a user

Authorization

Path Parameters

Response Body

`application/json`

`application/scim+json`

`application/scim+json`

`application/scim+json`

Change a user

Authorization

Path Parameters

Request Body

Response Body

`application/json`

`application/scim+json`

`application/scim+json`

`application/scim+json`

`application/scim+json`

`application/scim+json`

`application/scim+json`

Remove a user

Authorization

Path Parameters

Response Body

`application/scim+json`

`application/scim+json`