---
title: "List all Users"
method: GET
path: "/Users"
tags: ["Users"]
---

# List all Users

`GET /Users`

## Request

- Base URL: `https://ironcladapp.com/scim/v2`
- URL: `https://ironcladapp.com/scim/v2/Users`
- Auth: API key in header `Authorization`

Documentation on listing Users via SCIM. 

**OAuth Scope required:** `scim.users.readUsers`

## Query parameters

- `startIndex` integer
- `count` integer
- `filter` string
- `excludedAttributes` string

## Headers

- `x-as-user-email` string
- `x-as-user-id` string

## Response `200`

200 OK

- object
  - `schemas` string[]
  - `totalResults` integer: The total number of users that match this filter. This may be larger than the number of users in this page, in which case pagination may be used to retrieve the next page of results.
  - `Resources` UserResponseObject[]: The current page of user results.
    - `schemas` string[], required
    - `userName` string: The email address of the user (e.g., jdoe@acme.com).
    - `name` object: The first name and last name of the user.
      - `givenName` string: The first name of the user.
      - `familyName` string: The last name of the user.
    - `title` string: The user's legal title.
    - `id` string, required: The user's unique identifier.
    - `emails` object[]: A list of emails associated with the user. The email with type work and primary flag is typically copied from the main email stored in the userName property.
      - `value` string: The email address value.
      - `type` string: The type of email this is. Canonical values include 'work', 'home', and 'other'.
      - `primary` boolean: Whether this is the user's primary email address.
    - `active` boolean: Whether the user is currently active. A value of `false` means the user has been deactivated — deactivated users are blocked from logging in and are hidden from user-pickers and search results.
    - `urn:ietf:params:scim:schemas:extension:enterprise:2.0:User` object: Enterprise User attributes
      - `department` string: Which department the user is a part of.
    - `urn:ietf:params:scim:schemas:extension:ironclad:2.0:User` object: Ironclad User attributes
      - `departmentHead` string, email: The email address (username) of the user's department head.
      - `provider` 'local' | 'magicLink' | 'saml' | 'google': The user's authentication method.
      - `allowProviderConversion` boolean: Whether the user is allowed to convert from `local` to `google` provider.
    - `meta` object: Metadata for the user.
      - `resourceType` 'User': Type of the SCIM resource. In this case: 'User'.
      - `created` string: When the User was created.
      - `lastModified` string: When the User was last modified.
      - `location` string, url: The URI of the User resource being returned.
  - `startIndex` integer: The 1-based index of the first result in the current set of list results.
  - `itemsPerPage` integer: Specifies the maximum number of resources that can be returned in a single page of results.

## Other responses

- `400`: 400 Bad Request
- `403`: 403 Forbidden
- `500`: 500 Internal Server Error

---

[API](https://skmtc.dev/ironcladapp/apis/ironclad-scim-api.md) - [All operations](https://skmtc.dev/ironcladapp/apis/ironclad-scim-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ironcladapp/apis/ironclad-scim-api/revisions/ee9d1adddc38?raw)