GuidesAPI ReferenceRecipes
API Reference
Request a Demo
Start typing to search…

Create a User

post
https://na1.ironcladapp.com/scim/v2/Users

Documentation on creating a User via SCIM.

OAuth Scope required: scim.users.createUsers

Query Params
string

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

Body Params
schemas
array of strings
required
Defaults to urn:ietf:params:scim:schemas:core:2.0:User
schemas*
string
required

The email address of the user (e.g., [email protected]).

name
object
required

The first name and last name of the user.

string

The user's legal title.

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

Whether the user is currently active. Ironclad users cannot be marked as inactive, and will be removed from the company if this is set to false.

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
object

Enterprise User attributes

urn:ietf:params:scim:schemas:extension:ironclad:2.0:User
object

Ironclad User attributes

Headers
string

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. More information about permissions.

string

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. More information about permissions.

Responses

Updated 7 months ago

Language
Credentials
Header
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago