TOtoriihq
SCIM

List Users

Retrieve all the active users in Torii. <br>Active users can log in to Torii and/or the App Catalog and/or the Browser Extension.

<p><ul><li>Rate limit: 200 requests per minute</li></ul></p>
get/scim/v2/Users

Request

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

Query parameters

filterstring

<a href="https://www.rfc-editor.org/rfc/rfc7644#section-3.4.2.2">SCIM filter query</a> <br><small>Only <b>userName</b> and <b>emails</b> are supported.</small> <br><small>Complex filters (and/or/not) are not supported.</small>

sortBystring

Sort results by key.

sortOrder'ascending' | 'descending'

Sort order.

startIndexnumber

First result index.

countinteger

Results per page.<small><br>Default: 100<br>Max: 200</small>.

Response

SCIM Response Schema

schemasModel68[] required

An array of Strings containing URIs that are used to indicate the namespaces of the SCIM schemas that define the attributes present in the current JSON structure.

totalResultsnumber required
itemsPerPagenumber required
startIndexnumber required

Example response

{
  "schemas": [
    [
      "urn:ietf:params:scim:schemas:core:2.0:User"
    ]
  ],
  "totalResults": 1000,
  "itemsPerPage": 1,
  "startIndex": 1,
  "Resources": [
    {
      "schemas": [
        [
          "urn:ietf:params:scim:schemas:core:2.0:User"
        ]
      ],
      "id": "1234",
      "userName": "tony@stark.com",
      "name": {
        "familyName": "Stark",
        "givenName": "Tony"
      },
      "active": true,
      "emails": [
        {
          "primary": true,
          "value": "tony@stark.com"
        }
      ],
      "userType": "Admin",
      "meta": {
        "created": "2022-01-01T00:00:00.000Z"
      }
    }
  ]
}

Changes

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