UNunqork
Users

Update User

Changed on

Updates a single user. Partial updates are supported. To delete a specific custom attribute, pass null for that attribute.

Authorization Required:

  • Designer Administrator
put/users/{userId}

Request

Path parameters

userIdstring required

ID of user to update

Query parameters

shouldNotifyboolean

Controls the distribution of the New Account (Token Invitation) email.

  • true: Sends both the "New Account" email and the "User Changed" email.
  • false: Suppresses the "New Account" email only. The "User Changed" email is still sent to the user.

Note: This parameter acts specifically on the Token Invitation workflow and does not globally suppress all system notifications.

Request body

userIdstring

The unique identifier of the user account. The userId can only include letters, numbers, and the following characters @,+-_.

Immutable: This value cannot be modified. If provided in the request body, it must match the userId in the path, or it will be ignored.

namestring

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

emailstring email

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

Complexity is enforced from the environment's password requirements, so the effective bounds are per-environment rather than fixed. Read that configuration for the values that apply; the platform defaults are a minimum length of 12, a maximum of 64, and at least one lowercase letter, one uppercase letter, one number, and one symbol. Service users (isServiceUser: true) are the exception - their minimum length is forced to 32 and their maximum to 64, overriding whatever the environment configures, and all four character classes are always required.

isServiceUserboolean
...customAttributesstring

Custom attributes can be included as additional keys in the request body. Only string values of custom attributes are supported - an object value is rejected with 400 Invalid attribute "<key>": Object not allowed. Reserved keys are silently dropped rather than rejected, so a custom attribute must not reuse one of: userId, email, phone, name, role, password, created, modified, passwordHash, passwordHistory, passwordStatus, passwordExpiry, credentialExpired, groups, applicationRoles, lastLogin, isServiceUser, designerRoles, expressRoles, isUserLocked, description, clientSecret.

Response

User updated

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.

Changes