Create User

Overview

Use this API to create a user. The logged in user can only create one user at a time. Only department users can be created.

Permissions

Actor	Permission
User	All of the following are required: If logged in as a department user: User must have 'Create User' action on 'User' resource. User must be created in the home department of the logged in user, or in the department in which the logged in user is a foreign user. If logged in as a global user, one of the following is required: User must have 'Administer' permission on the department in which the user is being created. User must have 'Manage partition resources' privilege.
Client Application	No additional permission is required.

Actor

Permission

User

All of the following are required:

If logged in as a department user:
- User must have 'Create User' action on 'User' resource.
- User must be created in the home department of the logged in user, or in the department in which the logged in user is a foreign user.
If logged in as a global user, one of the following is required:
- User must have 'Administer' permission on the department in which the user is being created.
- User must have 'Manage partition resources' privilege.

Client Application

No additional permission is required.

SecurityoAuthUser or oAuthClient

Request

header Parameters

Accept required	string Default: application/json Content type accepted by client. Enum: "application/json" "application/xml"
Accept-Language required	string Default: en-US Language locale accepted by client (used for locale specific fields in resource representation and in error responses). Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"

Request Body schema: application/json

	object (title) Title of the user.
firstName required	string (firstName) [ 1 .. 124 ] characters [a-zA-Z0-9]\|@\|\s\|:\|.\|_\|-\|&\|[\x80-\xFF] First name of the user.
middleName	string (middleName) [ 1 .. 124 ] characters [a-zA-Z0-9]\|@\|\s\|:\|.\|_\|-\|&\|[\x80-\xFF] Middle name of the user.
lastName required	string (lastName) [ 1 .. 124 ] characters [a-zA-Z0-9]\|@\|\s\|:\|.\|_\|-\|&\|[\x80-\xFF] Last name of the user.
screenName required	string (screenName) [ 1 .. 30 ] [a-zA-Z0-9]\|@\|\s\|:\|.\|_\|-\|&\|[\x80-\xFF] Screen name of the user.
suffix	string (suffix) [ 1 .. 124 ] characters [a-zA-Z0-9]\|@\|\s\|:\|.\|_\|-\|&\|[\x80-\xFF] Suffix of the user.
	object (createdBy) Details of the user who created this user.
loginId required	string (loginId) <= 255 characters Login ID of the user.
password required	string (password) Password for the user. This must adhere to the password complexity settings as configured in the application.
	object (authenticationType) Authentication type for the user.
	object (status) Status of the user.
	object (manager) Manager of the user.
emailAddress	string (emailAddress) <= 255 characters ^[a-zA-Z0-9-_]+@[a-zA-Z0-9-_]+\.[a-zA-Z0-9]+$... Primary email address of the user.
mobileNumber	string (mobileNumber) [ 5 .. 20 ] Mobile number of the user.
	object (directReports) Direct reports to the user.
required	object (departments) Departments of the user.
	object (groups) Group details of the user.
	object (languages) Content languages of the user.
externalId	string (externalId) [ 1 .. 255 ] characters External ID for the user.
	object (CustomAttributes) Custom attributes for the user.

Responses

201

When created successfully

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal server error

post/user

Request samples

Payload
curl
JavaScript
Node.js

application/json

Creating a user by providing only the required attributes.
POST /core/usermgr/v3/user

{"firstName": "Anthony",
"lastName": "Shephard",
"screenName": "anthony",
"loginId": "ashephard",
"password": "password@123",
"departments": {"department": [{"name": "Service",
"home": "yes"
}
]
}
}

Response samples

application/json

{"code": "400-101",
"developerMessage": "Unsupported query parameter(s) supplied: '<query_parameter>'."
}