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

# Create a user

`POST /scim/v2/Users`

Creates a user. Must include the userName attribute and an email address. User will be created as an SSO user by default and a federated ID must be provided for the user.

## Headers

- `Idempotency-Key` string
- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string

## Request body

- object[] — Array of user resources returned by the bulk operation.
  - `schemas` string[], required — List of schema URNs defining the structure of the user resource.
  - `name` object, required — Name details of the user.
    - `givenName` string — User's first name.
    - `familyName` string — User's last name.
    - `formatted` string — Formatted full name.
  - `active` boolean, required — Indicates whether the user is active.
  - `emails` object[], required — List of email addresses associated with the user.
    - `value` string — Email address.
    - `type` string — Type of email (e.g., work, personal).
    - `primary` boolean — Indicates if this is the primary email.
  - `roles` object[], required — Roles assigned to the user.
    - `value` string — Role value (e.g., ADMIN).
  - `externalId` string, required — External identifier for the user.
  - `userName` string, required — Unique username for the user.
  - `preferredLanguage` string, required — User's preferred language.
  - `locale` string, required — User's locale.
  - `urn:zuora:scim:schemas:1.0:UserExtension` object, required — Custom extension schema with additional attributes for the user.
    - `schemas` string[] — List of URNs for the extension schemas.
    - `organizationId` string — Identifier for the associated organization.

## Response `200`

OK

- object
  - `schemas` string[]
  - `id` string — Unique identifier for the user.
  - `externalId` string — External identifier for the user.
  - `meta` object
    - `created` string, date-time — Timestamp of when the user was created.
    - `resourceType` string — Type of the resource (e.g., User).
    - `location` string — URL of the user resource.
  - `userName` string — Unique username for the user.
  - `name` object
    - `formatted` string — Formatted full name.
    - `familyName` string — User's last name.
    - `givenName` string — User's first name.
  - `displayName` string — Display name of the user.
  - `preferredLanguage` string — User's preferred language.
  - `locale` string — User's locale.
  - `active` boolean — Indicates whether the user is active.
  - `emails` object[]
    - `value` string — Email address.
    - `display` string — Display version of the email.
    - `type` string — Type of email (e.g., work, personal).
    - `primary` boolean — Indicates if this is the primary email.
  - `roles` object[]
    - `value` string — Role value (e.g., ADMIN).
    - `display` string — Display version of the role.
  - `urn:zuora:scim:schemas:1.0:UserExtension` object
    - `schemas` string[]
    - `organizationId` string — Identifier for the associated organization.
    - `status` string — Current status of the user.
    - `ssoEnabled` boolean — Indicates if SSO is enabled for the user.
    - `region` string — Region associated with the user.

## Other responses

- `201` — Created
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)