---
updatedAt: 2026-05-28T09:06:15.000Z
agentTools:
  projectIndex: https://developer.oneflow.com/llms.txt
---

# List Users

Use this endpoint to get the list of users.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "x-readme": {
    "explorer-enabled": false,
    "samples-languages": [
      "curl",
      "python"
    ]
  },
  "info": {
    "description": "This section describes the Oneflow SCIM API.",
    "version": "1",
    "title": "SCIM API for Oneflow"
  },
  "servers": [
    {
      "url": "https://{hostname}/scim/v1",
      "variables": {
        "hostname": {
          "default": "api.oneflow.com"
        }
      }
    }
  ],
  "paths": {
    "/Users": {
      "get": {
        "tags": [
          "Users"
        ],
        "summary": "List Users",
        "operationId": "list-users",
        "description": "Use this endpoint to get the list of users.",
        "security": [
          {
            "bearerAuth": []
          }
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/sortBy"
          },
          {
            "$ref": "#/components/parameters/sortOrder"
          },
          {
            "$ref": "#/components/parameters/startIndex"
          },
          {
            "$ref": "#/components/parameters/count"
          },
          {
            "$ref": "#/components/parameters/attributes"
          },
          {
            "$ref": "#/components/parameters/excludedAttributes"
          },
          {
            "$ref": "#/components/parameters/filter"
          }
        ],
        "responses": {
          "200": {
            "description": "Returns the list of users, optionally user attributes are filtered by attributes or excludedAttributes parameters.",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/UsersList"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UsersList"
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/401"
          }
        }
      }
    }
  },
  "components": {
    "parameters": {
      "attributes": {
        "name": "attributes",
        "description": "When included, each resource returned will contain the minimum set of resource attributes and any attributes or sub-attributes explicitly requested.",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "pattern": "^[a-zA-Z0-9$\\.,:-]+$"
        },
        "example": "displayName,externalId,meta.lastModified"
      },
      "excludedAttributes": {
        "name": "excludedAttributes",
        "description": "When included, each resource returned will contain the minimum set of resource attributes. Additionally, the default set of attributes minus those attributes listed in \"excludedAttributes\" is returned.",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "pattern": "^[a-zA-Z0-9$\\.,:-]+$"
        },
        "example": "displayName,externalId,meta.lastModified"
      },
      "filter": {
        "name": "filter",
        "description": "When included, the resources must match the given criteria to be included in the response.",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        },
        "example": "externalId eq \"abc\""
      },
      "sortBy": {
        "name": "sortBy",
        "description": "The 'sortBy' parameter specifies the attribute whose value is used to order the returned responses.",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "example": "displayName"
        }
      },
      "sortOrder": {
        "name": "sortOrder",
        "description": "The order in which the 'sortBy' parameter is applied. Defaults to ascending.",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "ascending",
            "descending"
          ],
          "default": "ascending"
        }
      },
      "startIndex": {
        "name": "startIndex",
        "description": "A pagination parameter. It is the 1-based index of the first query result. A value less than 1 will be rounded up to 1.",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer",
          "default": 1
        }
      },
      "count": {
        "name": "count",
        "description": "A pagination parameter. Specifies the desired maximum number of query results per page. A negative value will be rounded up to 0.",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer",
          "default": 100
        }
      }
    },
    "responses": {
      "401": {
        "description": "The SCIM token is invalid."
      }
    },
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "x-bearerInfoFunc": "scim.utils.utils.get_bearer_token"
      }
    },
    "schemas": {
      "User": {
        "type": "object",
        "x-canonicalize-keys": true,
        "x-convert-boolean-active-value": true,
        "additionalProperties": false,
        "description": "Represents a user.",
        "properties": {
          "active": {
            "description": "Indicates if the user is active/enabled.",
            "type": "boolean",
            "default": true
          },
          "displayName": {
            "description": "The name of the user, suitable for display to end-users.",
            "type": "string"
          },
          "name": {
            "description": "Compatibility attribute, writes are allowed but discarded. Empty strings when read from.",
            "type": "object",
            "properties": {
              "formatted": {
                "type": "string"
              },
              "familyName": {
                "type": "string"
              },
              "givenName": {
                "type": "string"
              },
              "middleName": {
                "type": "string"
              },
              "honorificPrefix": {
                "type": "string"
              },
              "honorificSuffix": {
                "type": "string"
              }
            }
          },
          "password": {
            "description": "Compatibility attribute. Write-only, never returned. Writes are discarded.",
            "type": "string"
          },
          "roles": {
            "type": "array",
            "minItems": 0,
            "items": {
              "type": "object",
              "additionalProperties": false,
              "description": "Roles that grants the user something",
              "properties": {
                "type": {
                  "description": "Type Identifier",
                  "type": "string",
                  "nullable": true
                },
                "display": {
                  "description": "Roles display name",
                  "type": "string",
                  "nullable": true
                },
                "value": {
                  "description": "Roles value",
                  "type": "string"
                },
                "primary": {
                  "description": "Roles primary",
                  "type": "boolean"
                }
              }
            }
          },
          "externalId": {
            "description": "A custom, user-supplied ID.",
            "type": "string",
            "maxLength": 100,
            "nullable": true
          },
          "groups": {
            "description": "A list of groups to which the user belongs, either through direct membership, through nested groups, or dynamically calculated.",
            "type": "array",
            "minItems": 0,
            "items": {
              "type": "object",
              "additionalProperties": false,
              "description": "The group the user belongs to.",
              "properties": {
                "display": {
                  "description": "Compatibility field, accepted but discarded.",
                  "type": "string",
                  "nullable": true
                },
                "type": {
                  "description": "The name of the resource type of the resource. Always 'Group.'",
                  "type": "string",
                  "default": "Group"
                },
                "value": {
                  "description": "The ID of the group.",
                  "type": "string"
                },
                "x-ref": {
                  "description": "The URI of the corresponding \"Group\" resources to which the user belongs.",
                  "type": "string"
                }
              }
            }
          },
          "id": {
            "description": "The ID of this resource instance.",
            "type": "string",
            "pattern": "^[0-9]+$"
          },
          "locale": {
            "description": "Indicate the User's default location for purposes of localization. It is the language tag only (no region).",
            "type": "string",
            "pattern": "^[a-z]{2}$",
            "example": "en"
          },
          "meta": {
            "description": "An object containing user metadata properties.",
            "type": "object",
            "additionalProperties": false,
            "nullable": true,
            "properties": {
              "created": {
                "description": "The time when the user was created.",
                "type": "string",
                "format": "datetime"
              },
              "lastModified": {
                "description": "The time when the user was last modified.",
                "type": "string",
                "format": "datetime"
              },
              "location": {
                "description": "The URI of the user being returned.",
                "type": "string"
              },
              "resourceType": {
                "description": "The name of the resource type of the resource. Always 'User.'",
                "type": "string",
                "default": "User"
              }
            }
          },
          "phoneNumbers": {
            "description": "Phone numbers for the user.",
            "type": "array",
            "minItems": 0,
            "maxItems": 1,
            "items": {
              "type": "object",
              "additionalProperties": false,
              "description": "The user's phone number.",
              "properties": {
                "primary": {
                  "description": "Whether or not the phone number is the user's primary phone number.",
                  "type": "boolean"
                },
                "value": {
                  "description": "The user's phone number.",
                  "type": "string",
                  "nullable": true
                },
                "type": {
                  "description": "The phone number type.",
                  "type": "string"
                }
              }
            }
          },
          "schemas": {
            "description": "A schema for representing the user's configuration.",
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "urn:ietf:params:scim:schemas:core:2.0:User",
                "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
              ]
            }
          },
          "title": {
            "description": "The user's title.",
            "type": "string",
            "nullable": true,
            "example": "Vice President"
          },
          "userName": {
            "description": "A service provider's unique identifier for the user, typically used by the user to directly authenticate to the service provider.",
            "type": "string"
          }
        }
      },
      "UsersList": {
        "type": "object",
        "additionalProperties": false,
        "description": "Represents list of users.",
        "required": [
          "totalResults",
          "Resources"
        ],
        "properties": {
          "itemsPerPage": {
            "description": "The number of resources returned in a list response page.",
            "type": "integer"
          },
          "Resources": {
            "description": "A list of the Users.",
            "type": "array",
            "minItems": 0,
            "items": {
              "$ref": "#/components/schemas/User"
            },
            "nullable": false
          },
          "schemas": {
            "description": "A schema for representing the resource list configuration.",
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "urn:ietf:params:scim:api:messages:2.0:ListResponse"
              ]
            }
          },
          "startIndex": {
            "description": "The 1-based index of the first result in the current set of list results.",
            "type": "integer"
          },
          "totalResults": {
            "description": "The total number of results returned by the list or query operation.",
            "type": "integer"
          }
        }
      }
    }
  }
}
```