---
title: "Create a User"
method: POST
path: "/Users"
tags: ["Users"]
---

# Create a User

`POST /Users`

## Request

- Base URL: `https://ironcladapp.com/scim/v2`
- URL: `https://ironcladapp.com/scim/v2/Users`
- Auth: API key in header `Authorization`

Documentation on creating a User via SCIM. 

**OAuth Scope required:** `scim.users.createUsers`

## Query parameters

- `excludedAttributes` string

## Headers

- `x-as-user-email` string
- `x-as-user-id` string

## Request body

- object
  - `schemas` string[], required
  - `userName` string, required: The email address of the user (e.g., jdoe@acme.com).
  - `name` object, required: The first name and last name of the user.
    - `givenName` string: The first name of the user.
    - `familyName` string: The last name of the user.
  - `title` string: The user's legal title.
  - `password` string: The user's password for username/password type sign in method. Required if there are no SAML configurations set up for the company. Password requirements: - 16+ characters - At least one lowercase letter - At least one uppercase letter - At least one number - At least one special character (!"#$%&'()*+,-./:;<=>?@[\]^_`{|}~)
  - `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` object: Enterprise User attributes
    - `department` string: Which department the user is a part of.
  - `urn:ietf:params:scim:schemas:extension:ironclad:2.0:User` object: Ironclad User attributes
    - `departmentHead` string, email: The email address (username) of the user's department head.
    - `allowProviderConversion` boolean: Allow the user to convert from 'local' to 'google' provider.
  - `active` boolean: Setting `active` to `false` puts the user in Deactivated status on Ironclad, instantly blocking their access and freeing up their license seat. Deactivated users are hidden from user-pickers and search results to prevent new work from being assigned to them.

## Response `201`

201 Created

- UserResponseObject
  - `schemas` string[], required
  - `userName` string: The email address of the user (e.g., jdoe@acme.com).
  - `name` object: The first name and last name of the user.
    - `givenName` string: The first name of the user.
    - `familyName` string: The last name of the user.
  - `title` string: The user's legal title.
  - `id` string, required: The user's unique identifier.
  - `emails` object[]: A list of emails associated with the user. The email with type work and primary flag is typically copied from the main email stored in the userName property.
    - `value` string: The email address value.
    - `type` string: The type of email this is. Canonical values include 'work', 'home', and 'other'.
    - `primary` boolean: Whether this is the user's primary email address.
  - `active` boolean: Whether the user is currently active. A value of `false` means the user has been deactivated — deactivated users are blocked from logging in and are hidden from user-pickers and search results.
  - `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` object: Enterprise User attributes
    - `department` string: Which department the user is a part of.
  - `urn:ietf:params:scim:schemas:extension:ironclad:2.0:User` object: Ironclad User attributes
    - `departmentHead` string, email: The email address (username) of the user's department head.
    - `provider` 'local' | 'magicLink' | 'saml' | 'google': The user's authentication method.
    - `allowProviderConversion` boolean: Whether the user is allowed to convert from `local` to `google` provider.
  - `meta` object: Metadata for the user.
    - `resourceType` 'User': Type of the SCIM resource. In this case: 'User'.
    - `created` string: When the User was created.
    - `lastModified` string: When the User was last modified.
    - `location` string, url: The URI of the User resource being returned.

## Other responses

- `400`: 400 Bad Request
- `403`: 403 Forbidden
- `409`: 409 Conflict
- `500`: 500 Internal Server Error

---

[API](https://skmtc.dev/ironcladapp/apis/ironclad-scim-api.md) - [All operations](https://skmtc.dev/ironcladapp/apis/ironclad-scim-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ironcladapp/apis/ironclad-scim-api/revisions/ee9d1adddc38?raw)