Listing all user accounts¶

Sends a GET request to the endpoint /users.

Description¶

The List-Users request allows the user to request a list of all user accounts of the organisation.

Requirements¶

Values of the request: none

Objects: none

Request¶

To request a list of all user accounts, no additional information needs to be added to the path of the request.

As a result, the user gets one or more objects UserVO with the requested information.

The object provides the following information:

Attributes	Description	Values
`email`	The email address of the user account.	`string`
`login`	The login name that is the same as the email address.	`string`
`firstname`	The first name of the user.	`string`
`lastname`	The name of the user.	`string`
`organizationId`	The id of the organisation to which the user account is assigned.	`integer`
`organizationName`	The name of the organisation to which the user account is assigned.	`string`
`active`	Shows if this is an active user account or if the user account is inactive.	`active` `inactive`
`locked`	Shows if the user account is locked.	`true` `false`
`agent`	Shows if the user account is an agent for this organisation.
`tfaEnabled`	Shows if the user account has 2FA activated.	`true` `false`
`tfaRequired`	Defines if the user account is forced to activate 2FA.	`true` `false`
`roles`	An array with permission roles of a user account.	`ADMINISTRATOR` `USER`
`rootGroupRoles`	An array with information about group permissions for the user account.	`ADMINISTRATOR` `USER`
`sessions`	An array with one or more objects `UserSessionVO` with information about active sessions of the user account.
`isIndirectCustomer`	Shows if the user account is a user account of a partner or a direct customer of Myra.	`true` `false`
`id`	The ID of the entry.	`integer`
`modified`	The last modification date in ISO 8601 format.	`string($date-time)`
`created`	The creation date in ISO 8601 format.	`string($date-time)`

Example¶

Example response:

[
  {
    "email": "string",
    "login": "string",
    "firstname": "string",
    "lastname": "string",
    "organizationId": 0,
    "organizationName": "string",
    "active": "active",
    "locked": true,
    "agent": "string",
    "tfaEnabled": true,
    "tfaRequired": true,
    "roles": "ADMINISTRATOR",
    "rootGroupRoles": "ADMINISTRATOR",
    "sessions": "string",
    "isIndirectCustomer": true,
    "id": 0,
    "modified": "2026-01-01T00:00:00+00:00",
    "created": "2026-01-01T00:00:00+00:00"
  }
]

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	A list of `UserVO` elements.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.