Sign in
latestOpenAPI 3.0.32026-08-109359194.9 KB

112399a67ebb

Users

Create User

Creates a new user. If userId is not specified, it is auto-generated and returned.

Authorization Required:

  • Designer Administrator
post/users

Query parameters

shouldNotifyboolean

Whether to notify the user via email of their temporary password.

skipTemporaryPasswordboolean

Whether to set the user's password as permanent immediately. A password must be provided in the body if this flag is set. This flag cannot be used if "shouldNotify" is also set.

Request body

userIdstring

The userId can only include letters, numbers, and the following characters @,+-_.

namestring required

The name can only include letters, numbers, and the following characters @,+-_.'

emailstring email required

Quotes and special characters "(),:;<>@[]\ are not allowed. The local portion of the email (e.g. local@domain.com) must be > 0 characters and < 64 charaters. There cannot be consecutive dots (e.g. ..) in the email

phonestring

Must be a valid US phone number unless the country code is specified, in which case it is validated with libphonenumber-js

rolestring

One of the roles configured in Unqork

expressRolesstring[]

Express roles configured in Unqork

groupsstring[]

List of groups configured in Unqork OR comma-separated list of groups configured in Unqork (e.g. "group1,group2")

applicationRolesobject

Map of applications to roles OR comma-separated list of application-role mappings (e.g. "application1:role1,application2:role2")

passwordstring password
isServiceUserboolean
...customAttributesstring

Custom attributes can be included as additional keys in the request body. Only string values of custom attributes are supported.

Response

User created

userIdstring required
namestring required
emailstring required
phonestring
rolestring

One of the roles configured in Unqork

expressRolesstring[]

Express roles configured in Unqork

groupsstring[]

List of groups configured in Unqork

applicationRolesobject

Map of applications to roles

createdstring date-time required
modifiedstring date-time required
isServiceUserboolean
lastLoginstring date-time
...customAttributesstring

Custom attributes will be included as additional keys in the response body.