NIninjarmm
organization

List users

Changed on

Returns list of end-users for organization

get/v2/organization/{id}/end-users

Request

Path parameters

idinteger required

Query parameters

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

  • e3ae1d639362Revision changes
    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

  • 7c00bdd989eeRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status