IRironcladapp
Users

Create a User

Documentation on creating a User via SCIM.

OAuth Scope required: scim.users.createUsers

post/Users

Request

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

Query parameters

excludedAttributesstring

A comma-separated list of attributes to exclude from the resources in the response.

Headers

x-as-user-emailstring
Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

x-as-user-idstring
Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

Request body

schemasstring[] required
userNamestring required

The email address of the user (e.g., jdoe@acme.com).

titlestring

The user's legal title.

passwordstring

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 (!"#$%&'()*+,-./:;<=>?@[]^_`{|}~)
activeboolean

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.

Example request

{
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "department": "Legal"
  },
  "urn:ietf:params:scim:schemas:extension:ironclad:2.0:User": {
    "departmentHead": "jane.doe@test.com"
  }
}

Response

201 Created

schemasstring[] required
userNamestring

The email address of the user (e.g., jdoe@acme.com).

titlestring

The user's legal title.

idstring required

The user's unique identifier.

activeboolean

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.

Example response

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "alex.doe@example.com",
  "name": {
    "givenName": "Alex",
    "familyName": "Doe"
  },
  "title": "Vice President",
  "id": "6660d37dec0eac3deffb680e",
  "emails": [
    {
      "value": "alex.doe@example.com",
      "type": "work",
      "primary": true
    }
  ],
  "active": true,
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "department": "Legal"
  },
  "urn:ietf:params:scim:schemas:extension:ironclad:2.0:User": {
    "departmentHead": "jane.doe@test.com",
    "provider": "local"
  },
  "meta": {
    "resourceType": "User",
    "created": "2025-03-26T18:33:48.336Z",
    "lastModified": "2025-03-26T18:33:48.336Z",
    "location": "https://ironcladapp.com/scim/v2/Users/67e4488c605caf0d8aa2e5c6"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.