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

# List SCIM Users

`GET /v1/scim/Users`

Retrieves a list of users in the SCIM system, with optional pagination

## Query parameters

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

## Response `200`

A paginated list of users in the organization

- ListSCIMUserModelsResponse
  - `totalResults` integer — Total number of users that match the filter criteria
  - `startIndex` integer — The index of the first returned result
  - `itemsPerPage` integer — The number of results returned in this page
  - `Resources` SCIMUserModel[] — List of SCIM user resources
    - `schemas` string[], required — Defines the SCIM schemas for the user
    - `userName` string, required — Unique identifier for the user (email)
    - `name` NameInfo, required
      - `givenName` string, required — Given name of the user (firstName)
      - `familyName` string, required — Family name of the user (lastName)
    - `emails` object[], required — Sumo logic accepts only one email address
      - `value` string, email
      - `type` string
      - `primary` boolean
    - `roles` unknown[], required — roles should exactly match with role names within sumologic. `roles` can be either `Array of strings` or `Array of objects` as shown in the payload. `primary` always set to 'true' as sumologic doesn't have a concept of primary/secondary roles
      - unknown
    - `id` string, required — Unique SCIM identifier for the user
    - `active` boolean — True if the user is active
    - `meta` ResourceData — Resource meta data of a user
      - `resourceType` string — The name of the resource type of the resource
      - `created` string, date-time — Creation timestamp in date-time format
      - `lastModified` string, date-time — Last modification timestamp in date-time format

## Other responses

- `default` — Operation failed with an error

---

[API](https://skmtc.net/sumologic/apis/sumo-logic-api.md) · [All operations](https://skmtc.net/sumologic/apis/sumo-logic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sumologic/sumo-logic-api/revisions/18a824df1e78/schema)