---
title: "Create user"
method: POST
path: "/scim/v2/users"
tags: ["Users"]
---

# Create user

`POST /scim/v2/users`

Create a user.

## Request body

- object
  - `displayName` string, required — The user's display name
  - `userName` string, email, required — The user's email address
  - `urn:omni:params:1.0:UserAttribute` object — [User attributes](/administration/users/attributes) as key/value pairs, where keys map to the IDs of user attributes defined in Omni. This is the **Reference** column in the **User attributes** page.

## Response `201`

User created successfully

- ScimUser
  - `id` string — Unique identifier for the user
  - `userName` string — The user's email address
  - `displayName` string — The user's display name
  - `active` boolean — Whether the user is active
  - `emails` object[] — The user's email addresses
    - `primary` boolean — Whether this is the user's primary email
    - `value` string — The email address
  - `groups` object[] — User groups that the user belongs to
    - `display` string — The group's display name
    - `value` string — The group's unique identifier
  - `meta` object
    - `resourceType` string — The resource type. This will be `User`.
    - `created` string, date-time — The time the user was created
    - `lastModified` string, date-time — The time the user was last updated
  - `schemas` string[] — SCIM information about the type of schemas used in the API. For example, `urn:ietf:params:scim:schemas:core:2.0:User`
  - `urn:omni:params:1.0:UserAttribute` object — [User attributes](/administration/users/attributes) as key/value pairs, where keys map to the IDs of user attributes defined in Omni. This is the **Reference** column in the **User attributes** page.
  - `urn:omni:params:scim:schemas:extension:user:2.0` object — Omni SCIM extension schema containing additional user metadata
    - `lastLogin` string, date-time, nullable — The timestamp of the user's last login. Will be `null` if the user has never logged in.

## Other responses

- `429` — Too Many Requests - Rate limit exceeded (60 requests/minute)

---

[API](https://skmtc.net/omni/apis/omni-api.md) · [All operations](https://skmtc.net/omni/apis/omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/omni/omni-api/revisions/6b02f7349d0e/schema)
