---
title: "List Users"
method: GET
path: "/scim/v2/Users"
tags: ["SCIM"]
---

# List Users

`GET /scim/v2/Users`

## Request

- Base URL: `https://api.toriihq.com/v1.0`
- URL: `https://api.toriihq.com/v1.0/scim/v2/Users`
- Auth: API key in header `Authorization`

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>

## Query parameters

- `filter` string
- `sortBy` string
- `sortOrder` 'ascending' | 'descending'
- `startIndex` number
- `count` integer

## Response `200`

SCIM Response Schema

- SCIMResponse: SCIM Response Schema
  - `schemas` Model68[], 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.
  - `totalResults` number, required
  - `itemsPerPage` number, required
  - `startIndex` number, required
  - `Resources` SCIMUser[]: SCIM users array.
    - `schemas` Model70[], 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.
    - `id` string: The user's ID in Torii
    - `userName` string: Must be an email address. Cannot be changed after the user is created.
    - `name` SCIMNameSchema: The components of the user's real name.
      - `familyName` string: The user's family name.
      - `givenName` string: The user's given name.
    - `active` boolean: A Boolean value indicating the User's administrative status.
    - `emails` SCIMEmail[]: The user's email addresses. Cannot be changed after the user is created
      - `primary` boolean
      - `value` string, required
    - `userType` string: The role of the user in Torii.
    - `meta` SCIMMetaSchema
      - `created` string: The user's creation time.

---

[API](https://skmtc.dev/toriihq/apis/torii-api-documentation.md) - [All operations](https://skmtc.dev/toriihq/apis/torii-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/toriihq/apis/torii-api-documentation/revisions/15fd1512591b?raw)