Sign in
system

List users

Returns list of users

get/v2/users

Query parameters

userType'TECHNICIAN' | 'END_USER'

User type filter

includeRolesboolean

Includes user role information

Response

default response

idinteger

User identifier

uidstring uuid

User universally unique identifier

firstNamestring
lastNamestring
emailstring
phonestring
enabledboolean
administratorboolean
permitAllClientsboolean
notifyAllClientsboolean
mustChangePwboolean
mfaConfiguredboolean
userType'TECHNICIAN' | 'END_USER'
invitationStatus'REGISTERED' | 'PENDING' | 'EXPIRED'
organizationIdinteger

Identifier of organization for end-users

deviceIdsinteger[]

Device IDs which end-user is authorized to access

assignedDeviceIdsinteger[]

Device IDs which user is assigned

rolesstring[]

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

Changes

No recorded changes to this endpoint across all 2 revisions of this API.