user

Return all users within an org or across orgs

get/v1/user

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/user
  • Auth: none declared

Query parameters

orgIdstring

Org id to search within

idsstring

List of user ids to look up

fromstring

User id to start from

limitinteger

Number of results to return

sortstring

Sort by: id, name, email, inviteStatus, activeAt, updateAt. Prepend - for descending (e.g. -activeAt). Without orgId (cross-org admin only), 'activeAt' takes the legacy iterateAllActive path.

qstring

Substring search across name (first/last/preferred) and email

inviteStatus'INVITED' | 'JOINED' | 'NOT_INVITED'

Filter by invite status: JOINED (user has logged in) or INVITED (not yet logged in). NOT_INVITED is not valid here — by definition findUsers returns only users with accounts.

roleIdstring

Custom role id to filter by. Requires orgId.

policyIdstring

Policy id to filter by -- returns users with this policy assigned directly (not via their role). Requires orgId.

hasCustomPoliciesboolean

If true, returns only users with at least one directly-assigned policy. Requires orgId.

returnAccessstring

Return access information -- pass a comma-separated list of actions to check (e.g. update,delete). Requires orgId.

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "appId": "588f7ee98f138b19220041a7",
      "name": {
        "first": "Jane",
        "middle": "Quidditch",
        "last": "Public",
        "pref": "JQ",
        "prefLast": "Smith"
      },
      "email": "bob@example.com",
      "orgs": [
        {
          "orgId": "5887a7718f138b6a2a0041a7",
          "personId": "5887a7718f138b6a2a0041a7",
          "groupIds": [
            "588f7ee98f138b19220041a7"
          ],
          "roleId": "5887a7718f138b6a2a0041a7",
          "policyIds": [
            "588f7ee98f138b19220041a7"
          ],
          "homeEmail": "bob@example.com",
          "workEmail": "robert.doe@example.com",
          "workRoleId": "67c851da3dd1668c2fdd7e44"
        }
      ],
      "bundleInstall": {
        "entities": [
          {
            "entityId": "588f7ee98f138b19220041a7",
            "originalId": "588f7ee98f138b19220041a7"
          }
        ]
      },
      "activeAt": "2017-01-24T13:57:52Z",
      "loginAt": "2017-01-24T13:57:52Z",
      "appRunCheckAt": "2024-02-29T09:30:00Z",
      "title": "CEO",
      "remoteIp": "127.0.0.1",
      "createId": "588f7ee98f138b19220041a7",
      "createBehalfId": "588f7ee98f138b19220041a7",
      "createAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "createAt": "2017-01-24T13:57:52Z",
      "updateId": "588f7ee98f138b19220041a7",
      "updateBehalfId": "588f7ee98f138b19220041a7",
      "updateAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "updateAt": "2017-01-24T13:57:52Z",
      "verifyAt": "2017-01-24T13:57:52Z",
      "emailSettings": [
        {
          "category": "ADMINISTRATIVE"
        }
      ],
      "shareAccess": [
        {
          "userId": "5887a7718f138b6a2a0041a7",
          "groupId": "5887a7718f138b6a2a0041a7",
          "fields": "name,image,title"
        }
      ],
      "agentConfig": {
        "approvedPolicyRules": [
          {
            "departmentIds": [
              "588f7ee98f138b19220041a7"
            ],
            "filter": "department:engineering and under:me",
            "targets": [
              {
                "personId": "588f7ee98f138b19220041a7"
              }
            ]
          }
        ],
        "managerJobId": "588f7ee98f138b19220041a7",
        "contentIds": [
          "588f7ee98f138b19220041a7"
        ]
      }
    }
  ],
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 20 revisions of this API.