Skip to main content

List all users

GET 
/api/meshobjects/meshusers

Provides a paged list of meshUsers. Deleted meshUsers are not provided via this endpoint.

Every meshUser carries its lifecycle state in status.lifecycle. A user an identity provider has deactivated is DEACTIVATED and carries the date under status.lifecycle.deactivated. Use the lifecycleState parameter to list only those users. status.lastLogin tells you when each user last signed in, and is absent for a user who never did.

Note: In order to filter on WorkspaceUserGroups you must only specify the workspaceUserGroup Identifier and none of the other request parameters.

In case you filter on roles the response contains all meshUsers with that role regardless if they have been assigned directly or via a group. This offers for example a great opportunity to find the (contact) information of all Workspace Managers within one request, whereas the upcoming endpoints for the bindings (i.e. meshWorkspaceUserBinding, meshWorkspaceGroupBinding etc.) are not sufficient for this use-case. For that purpose several requests are required to cover direct user bindings and bindings via groups.

Note: Filtering on projects with the projectIdentifier requires a workspaceIdentifier, as a projectIdentifier is only unique within a meshWorkspace.

Authentication: This endpoint supports API Key authentication.

Request​

Responses​

200