Applications Users

List application users

Rate limit: 600 requests per minute

get/apps/{idApp}/users

Request

Base URL
https://api.toriihq.com/v1.0
Auth
API key in header Authorization

Path parameters

idAppinteger required

Unique app identifier

Query parameters

fieldsstring

A comma-separated list of fields to return for each user. When omitted, all fields are returned. Allowed fields include the standard application-user fields and all fields from /apps/fields.

sortstring

A comma-seperated list of fields to sort by, with a postfix with either ':asc' or ':desc'. Fields can either be general, or custom to your organization

qstring

A query to search by

qFieldsstring

A comma-seperated list of fields the query to search applies to. Fields can either be general, or custom to your organization

status'deleted' | 'active' | 'managed'

The user status to filter by

sizeinteger

The max amount of results to return

cursorstring

A base64 string indicating the offset from which to start. <br>Pass the value of nextCursor returned from the previous call to get the next set of results

Response

Application Users

countinteger

totalinteger

nextCursorstring

A base64 string indicating the offset from which to start. <br>Pass the value of nextCursor returned from the previous call to get the next set of results

Example response

{
  "users": [
    {
      "score": 1,
      "score60": 1,
      "score90": 1,
      "email": "tony@stark.com",
      "creationTime": "1970-01-01T00:00:00Z",
      "lastVisitTime": "1970-01-01T00:00:00Z",
      "appName": "Salesforce",
      "firstName": "Tony",
      "lastName": "Stark",
      "fullName": "Tony Stark",
      "status": "active",
      "idExternalUser": "1",
      "idUser": 1000,
      "sources": [
        [
          "okta"
        ]
      ],
      "isUserRemovedFromApp": true,
      "isOwnerNotifiedToRemoveUser": true,
      "isNewUserInApp": true,
      "roles": [
        [
          "org admin",
          "site admin"
        ]
      ],
      "externalStatus": "Active",
      "isExternal": true,
      "isDeletedInIdentitySources": true,
      "identitySourcesDeletionTime": "1970-01-01T00:00:00Z",
      "isOffboardingIgnored": true,
      "photoUrl": "www.photo.com",
      "licenses": [
        []
      ],
      "isSupportLastVisit": true,
      "ignoreAccount": true,
      "appAccountName": "Account",
      "idAppAccount": 1,
      "creationTimeInApp": "1970-01-01T00:00:00Z",
      "lifecycleStatus": "active",
      "annualCost": 100,
      "annualCostConverted": 200
    }
  ],
  "count": 100,
  "total": 1000,
  "nextCursor": "WzE0NjM1Mzg4NTcsIjY1NDMyMyJd"
}

Changes

No recorded changes to this operation across all 1 revision of this API.