List Users

GET /auth/users

Returns a list of users

Required Permissions

Name
Conditions

Auth:Users:Read

Always Required

Request Params

The following query parameters can be appended to the url

Property
Type
Description

limit

Number - Optional

Maximum number of items included in response

paginationToken

String - Optional

Page cursor used (taken from the previous response nextPageToken).

Responses

  • See Common Errors for common errors.

  • See User Management Errors for user management specific errors.

Success - A list of users in the caller's org

{
    "items": [
      {
        "userId": "us-xxxx-xxxx-xxxxxxxx",
        "kind": "CustomerEmployee",
        "username": "[email protected]",
        "name": "Elon Musk",
        "orgId": "or-xxxx-xxxx-xxxxxxxx",
        "isActive": true,
        "isRegistered": true,
        "permissionAssignments": [
          {
            "permissionId": "pm-paris-lithi-17bf4kf01h8ajph4",
            "permissionName": "DfnsFullAdminAccess",
            "assignmentId": "",
            "operations": [
              "Wallets:Create",
              "Wallets:Read",
              "Wallets:Update"
            ]
          }
        ]
      },
      {
       "userId": "us-xxxx-xxxx-xxxxxxxx",
        "kind": "CustomerEmployee",
        "username": "[email protected]",
        "name": "Elon Musk",
        "orgId": "or-xxxx-xxxx-xxxxxxxx",
        "isActive": true,
        "isRegistered": true,
        "permissionAssignments": [],
      }
    ],
    "nextPageToken": "eJxNy8...." // optional
  }

Last updated