---
title: "Create a scim user. This type of user holds personally identifiable information"
method: POST
path: "/scim/users"
tags: ["scim"]
---

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

`POST /scim/users`

Requires **scim_user:write** scope.

## Request body

- ScimUserPost
  - `schemas` string[]
  - `externalId` string, required — A String that is an identifier for the resource as defined by the provisioning client.
  - `name` object
    - `familyName` string, required — The given name or first name of the User
    - `givenName` string, required — The family name or last name of the User
  - `emails` object[]
    - `value` string, email, required — The email address
  - `userType` 'live' | 'guest' — The user type
  - `urn:ietf:params:scim:schemas:extension:moneyhub:2.0:Subtenant` object — The name and associated providerId for the subtenant. Both providerId and name are required if subtenant is provided.
    - `providerId` string, required — The providerId associated with the subtenant
    - `name` string, required — The name of the subtenant

## Response `200`

Successful User Response

- ScimUser
  - `schemas` string[], required
  - `id` string, required — The unique identifier for a User.
  - `externalId` string, required — A String that is an identifier for the resource as defined by the provisioning client.
  - `meta` object, required
    - `resourceType` 'User', required — The name of the resource type of the resource.
    - `created` string, date-time, required — The date and time the resource was created.
  - `name` object, required
    - `familyName` string, required — The given name or first name of the User
    - `givenName` string, required — The family name or last name of the User
  - `emails` object[], required
    - `value` string, email, required — The email address
    - `primary` boolean, required — Indicates the primary email address. The primary attribute value 'true' MUST appear no more than once.
  - `userType` 'live' | 'guest' — The user type

## Other responses

- `400` — Unsuccessful Response - Bad request - Missing query parameters - Missing body properties
- `401` — Unsuccessful Response - Not authorised - Missing authorization header - Invalid access Token
- `403` — Unsuccessful Response - Forbidden - Invalid scopes
- `409` — Unsuccessful Response - Conflict

---

[API](https://skmtc.net/moneyhubenterprise/apis/moneyhub-identity-service.md) · [All operations](https://skmtc.net/moneyhubenterprise/apis/moneyhub-identity-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/moneyhubenterprise/moneyhub-identity-service/revisions/8841721f7aae/schema)