Update properties on a User.

patch

https://techcomcloudpra.qabeyondtrustcloud.com/api/config/v1/user/{id}

Modifies an existing user resource with the given {id}.
The failed_logins property may be set to 0 to unlock a user account that has too many failed logins.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

int32

required

1 to 2147483647

Unique identifier for the resource.

Body Params

A user object with modified properties.

username

string

length between 1 and 64

The username the user last used to log in. This attribute is read-only for non-local users.

password

length ≤ 256

The local user's password. This attribute is write-only for local users. It cannot be set in non-local user PATCH requests. It is not returned in GET requests. The minimum length is configured in Management -> Security -> Passwords

public_display_name

string

required

length between 1 and 64

The user's public display name. This attribute is read-only for users who belong to a security provider that synchronizes display names.

password_expiration

date-time | null

The date and time at which the local user's password will expire as an RFC3339 date-time string. This attribute is only returned for local users and can only be updated on local users. If not set or set to a null or empty value, then the local user's password never expires.

email_address

string

length between 3 and 255

The user's email address. This attribute is read-only for users who belong to a security provider that synchronizes email addresses.

preferred_email_language

string

length between 2 and 10

Defaults to en-us

Must be the locale code for one of the locales listed on the Localization → Languages page.

two_factor_type

string

enum

Defaults to optional

Controls whether multi-factor authentication is required for this user. 'require_totp' forces the user to set up a TOTP application. 'require_fido2' forces the user to register a FIDO2 security key. 'optional' allows the user to opt-in to two-factor authentication. This attribute is only available for local and LDAP users.

Allowed:

enabled

boolean

Defaults to true

True if this user is allowed to log in.

failed_logins

int32

Defaults to 0

The number of times this local user has failed to authenticate. This attribute is only returned for local users and can only be updated on local users. It is always 0 for new local users, so it is ignored in POST requests. You may set it to 0 in PATCH requests to unlock an account that has too many failed logins.

password_reset_next_login

boolean

Defaults to false

If true, this local user's password must be reset on their next login. This attribute is only returned for local users and can only be set on local users.

Responses

200Indicates the user was successfully updated and contains an updated user instance.

404The specified resource was not found.

422One or more request parameters are invalid. The body contains a general error message as well as a validation error dictionary.