---
title: "GET /v1/scim/users"
method: GET
path: "/v1/scim/users"
tags: ["SSOReadyService"]
---

# GET /v1/scim/users

`GET /v1/scim/users`

Gets a list of SCIM users in a SCIM directory.

## Query parameters

- `scimDirectoryId` string
- `organizationId` string
- `organizationExternalId` string
- `scimGroupId` string
- `pageToken` string

## Response `200`

OK

- ListSCIMUsersResponse
  - `scimUsers` SCIMUser[] — List of SCIM users.
    - `id` string — Unique identifier for this SCIM user.
    - `scimDirectoryId` string — SCIM directory this SCIM user belongs to.
    - `email` string — The SCIM user's email address.
    - `deleted` boolean — Whether the SCIM user has been deleted or deprovisioned from its SCIM directory.
    - `attributes` object — Arbitrary, potentially nested, attributes the Identity Provider included about the user. Typically, these `attributes` are used to pass along the user's first/last name, or whether they should be considered an admin within their company.
  - `nextPageToken` string — Value to use as `pageToken` for the next page of data. Empty if there is no more data.

## Other responses

- `default` — Default error response

## Changes

- **2024-08-13** `516b78b641b8` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/ssoready/apis/ssoreadyservice-api/changes/v1/scim/users/get.md)

---

[API](https://skmtc.dev/ssoready/apis/ssoreadyservice-api.md) · [All operations](https://skmtc.dev/ssoready/apis/ssoreadyservice-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ssoready/ssoreadyservice-api/revisions/0827d713f08e/schema)