v2

latestOpenAPI 3.0.12026-07-263104131.9 MB

management

Update a specific end user

Update a specific end user by their ID

patch/v2/user/end-user/{id}

Path parameters

idinteger required

End user identifier

Request body

firstNamestring

First name should be between 1 and 150 characters

lastNamestring

Last name should be between 1 and 150 characters

organizationIdinteger

Organization identifier

fullPortalAccessboolean

Gives end user full portal access

managerUidstring uuid

Manager identifier

Response

End user updated

idinteger

User identifier

uidstring uuid

User universally unique identifier

enabledboolean

User access status

firstNamestring

First name

lastNamestring

Last name

emailstring

Email address

phonestring

Phone number

organizationIdinteger

Identifier of organization for end-users

fullPortalAccessboolean

Has full portal access

mustChangePwboolean

Must change password during next login

mfaConfiguredboolean

At least one MFA method is configured

scimUserboolean

User created by SCIM

authTypestring

Authentication type, NATIVE or SSO

invitationStatus'REGISTERED' | 'PENDING' | 'EXPIRED'

User invitation status

assignedDeviceIdsinteger[]

Device IDs which user is assigned

accessibleDeviceIdsinteger[]

Device IDs which user has access to

rolesstring[]

A list of role names assigned to the user. This is provided when the 'includeRoles' query parameter is set to 'true'

managerUidstring uuid

Manager identifier