Sign in

v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB
scim

Create a scim user. This type of user holds personally identifiable information

Requires scim_user:write scope.

post/scim/users

Request body

schemasstring[]
externalIdstring required

A String that is an identifier for the resource as defined by the provisioning client.

userType'live' | 'guest'

The user type

Example request

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:moneyhub:2.0:Subtenant"
  ],
  "externalId": "a1b2c3d4-e5f6-7a8b-9cb0-1d2e3f4g5h6i",
  "name": {
    "givenName": "Andrea",
    "familyName": "Hedley"
  },
  "emails": [
    {
      "value": "andrea.hedley@moneyhub.com"
    }
  ],
  "userType": "live"
}

Response

Successful User Response

schemasstring[] required
idstring required

The unique identifier for a User.

externalIdstring required

A String that is an identifier for the resource as defined by the provisioning client.

userType'live' | 'guest'

The user type

Example response

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "id": "66b1d7bfb9e65500465bed70",
  "externalId": "a1b2c3d4-e5f6-7a8b-9cb0-1d2e3f4g5h6i",
  "meta": {
    "resourceType": "User",
    "created": "2024-08-06T07:58:55.000Z"
  },
  "name": {
    "givenName": "Andrea",
    "familyName": "Hedley"
  },
  "emails": [
    {
      "value": "andrea.hedley@moneyhub.com",
      "primary": true
    }
  ],
  "userType": "live"
}