scim.users.createUsers
External DocumentationTo learn more, visit the Ironclad documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Active | Select to create the user in an active state. When cleared, the user is created in Deactivated status, which instantly blocks their access and frees up their license seat. |
| Department | The department the user is a part of. |
| Department Head | The email address of the department head of the user. |
| First Name | The first name of the user. |
| Last Name | The last name of the user. |
| Password | The password of the user, used for the username and password sign-in method. Required if there are no SAML configurations set up for the company. The password must contain at least 16 characters, including at least one lowercase letter, one uppercase letter, one number, and one special character. |
| Schemas | A comma-separated list of the SCIM schemas that define the attributes in the request. The default is urn:ietf:params:scim:schemas:core:2.0:User. Add an extension schema alongside it when you set its attributes.For example: urn:ietf:params:scim:schemas:extension:enterprise:2.0:User when setting Department. |
| Title | The legal title of the user. |
| User Name | The email address of the user. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Allow Provider Conversion | Select to allow the user to convert from the local authentication provider to google. |
| Excluded Attributes | A comma-separated list of attributes to exclude from the user in the response. |
Example Output
{
"schemas": [
"string"
],
"id": "string",
"userName": "string",
"name": {
"givenName": "string",
"familyName": "string"
},
"title": "string",
"active": false,
"emails": [
{
"value": "string",
"type": "string",
"primary": false
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
"department": "string"
},
"urn:ietf:params:scim:schemas:extension:ironclad:2.0:User": {
"departmentHead": "string",
"provider": "string",
"allowProviderConversion": false
},
"meta": {
"resourceType": "string",
"created": "string",
"lastModified": "string",
"location": "string"
}
}