Creates a new user
- POST /users
Creates a new user.
Request
The user to create
-
user_namestringrequired -
The user's identifier
-
securityUserSecurityrequired -
A user's security information
-
rolesstring -
The set of roles assigned to a user
-
permissionsstring -
The distinct set of permissions allowed by the user's roles. These correspond to operationId values in the OpenAPI definition.
-
elevated_permissionsElevatedPermissions -
A user's elevated permissions status
-
enabledbooleanrequired -
True if the user has elevated permissions
-
expires_atstring -
The time at which the user's elevated permissions expire
-
passwordstring -
The user's password. Only used when modifying a user.
-
enabledboolean -
True if the user is enabled
-
security_realmUserSecurityRealm -
The security realm the user belongs to
-
metadataUserMetadata -
Metadata for a user
-
created_bystring -
The Id of the user that created this user
-
created_atstring -
The date and time when the user was created
-
updated_bystring -
The Id of the user that last updated this user
-
updated_atstring -
The date and time when the user was last updated
-
first_login_atstring -
The date and time when the user first logged in
-
last_login_atstring -
The date and time when the user last logged in
-
full_namestring -
The user's optional full name
-
emailstring -
The user's optional email address
-
builtinboolean -
True if the user is a built-in read-only user
Responses
User successfully created
-
user_namestringrequired -
The user's identifier
-
securityUserSecurityrequired -
A user's security information
-
metadataUserMetadata -
Metadata for a user
-
created_bystring -
The Id of the user that created this user
-
created_atstring -
The date and time when the user was created
-
updated_bystring -
The Id of the user that last updated this user
-
updated_atstring -
The date and time when the user was last updated
-
first_login_atstring -
The date and time when the user first logged in
-
last_login_atstring -
The date and time when the user last logged in
-
full_namestring -
The user's optional full name
-
emailstring -
The user's optional email address
-
builtinboolean -
True if the user is a built-in read-only user
- The provided user name is invalid. Check that it is not empty and it does not contain special characters. (code:
user.user_name.invalid) - Some of the provided roles are invalid. (code:
user.roles.invalid) - Some of the provided roles are forbidden. (code:
user.roles.forbidden) - Trying to set a restricted field. (code:
user.restricted_field)
-
errorsBasicFailedReplyElementrequired -
A list of errors that occurred in the failing request
Response Headers
-
x-cloud-error-codes The error codes associated with the response
The username is already in use. (code: user.user_name.conflict)
-
errorsBasicFailedReplyElementrequired -
A list of errors that occurred in the failing request
Response Headers
-
x-cloud-error-codes The error codes associated with the response