Sign in
Users

Create user

Create a new user. Requires MANAGE_USERS access right.

post/v1/users

Request body

namestring required

Login name (must be a valid object name)

Response

User created successfully

idinteger

User ID

guidstring uuid

User GUID

namestring

Login name

descriptionstring

User description

systemRightsinteger

System access rights bitmask

uiAccessRulesstring

UI access rules

attributesobject

Custom attributes

ldapDnstring nullable

LDAP distinguished name

ldapIdstring nullable

LDAP unique ID

createdinteger

Account creation time (Unix timestamp)

fullNamestring

Full name

graceLoginsinteger

Remaining grace logins

twoFAGraceLoginsinteger

Remaining two-factor authentication grace logins

authMethodinteger

Authentication method (0=Local, 1=RADIUS, 2=Certificate, 3=Certificate or Local, 4=Certificate or RADIUS, 5=LDAP)

certMappingMethodinteger

Certificate mapping method

certMappingDatastring nullable

Certificate mapping data

disabledUntilinteger

Disabled until time (Unix timestamp, 0 if not temporarily disabled)

lastPasswordChangeinteger

Last password change time (Unix timestamp)

lastLogininteger

Last login time (Unix timestamp)

minPasswordLengthinteger

Minimum password length (-1 for system default)

authFailuresinteger

Consecutive authentication failure count

emailstring

Email address

phoneNumberstring

Phone number

groupsinteger[]

List of group identifiers this user belongs to

Changes

Changed in 2 of the 115 revisions of this API.11

  • 30e75dc6a94c1See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • c6aaf3632e481See the full diff
    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog