---
title: "List the directory's users, newest first"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: EZGH SSO API

`GET /v1/organizations/{orgId}/sso/users`

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `oauth`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie

## Path parameters

- `ListUsers.path.orgId` (string, required)
  - format `uuid`

## Query parameters

- `ListUsers.query.limit` (integer, optional) — Page size, 1–100 (default 20).
  - min 1; max 100
- `ListUsers.query.cursor` (string, optional) — The previous page's nextCursor.
- `ListUsers.query.status` (string, optional)
  - one of `"active"`, `"suspended"`, `"pendingActivation"`

## Code samples

### cURL

```curl
curl --request GET \
  --url https://sso.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/sso/users \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://sso.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/sso/users';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://sso.ezghcloud.com/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/sso/users"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

A page of users.

#### Example

```json
{
  "nextCursor": "string",
  "users": [
    {
      "activatedAt": "2019-08-24T14:15:22Z",
      "createdAt": "2019-08-24T14:15:22Z",
      "department": "string",
      "directoryId": "786c2ec1-fb9a-4593-b705-005b34c18c18",
      "email": "string",
      "familyName": "string",
      "givenName": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "identityProviderId": "cabc3c19-9da4-42ad-97d5-81996b056f78",
      "lastSignInAt": "2019-08-24T14:15:22Z",
      "locked": true,
      "name": "string",
      "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
      "projectId": null,
      "region": "string",
      "resourceName": "string",
      "slug": "string",
      "source": "hosted",
      "status": "active",
      "tags": {
        "property1": "string",
        "property2": "string"
      },
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ]
}
```

- `ListUsers.response.200.nextCursor` (string | null, required)
- `ListUsers.response.200.users` (array<object>, required)
  - `ListUsers.response.200.users.activatedAt` (string | null, required)
    - format `date-time`
  - `ListUsers.response.200.users.createdAt` (string, required)
    - format `date-time`
  - `ListUsers.response.200.users.department` (string | null, required) — The user's department: ${user.department} in SAML attribute mappings.
  - `ListUsers.response.200.users.directoryId` (string, required)
    - format `uuid`
  - `ListUsers.response.200.users.email` (string, required)
  - `ListUsers.response.200.users.familyName` (string | null, required)
  - `ListUsers.response.200.users.givenName` (string | null, required)
  - `ListUsers.response.200.users.id` (string, required)
    - format `uuid`
  - `ListUsers.response.200.users.identityProviderId` (string | null, required) — The identity provider the user came from: for a SCIM user, the one whose SCIM token provisioned them; otherwise the one they're linked to at sign-in (the first linked, which created a JIT user). Null for none, or once it's deleted.
    - format `uuid`
  - `ListUsers.response.200.users.lastSignInAt` (string | null, required)
    - format `date-time`
  - `ListUsers.response.200.users.locked` (boolean, required) — Whether hand edits are refused right now (409 managed_by_scim): the user came from inbound SCIM and a live SCIM token of the same identity provider manages them. Computed on every read; source says where the user came from.
  - `ListUsers.response.200.users.name` (string, required)
  - `ListUsers.response.200.users.organizationId` (string, required)
    - format `uuid`
  - `ListUsers.response.200.users.projectId` (null, required)
  - `ListUsers.response.200.users.region` (string, required)
  - `ListUsers.response.200.users.resourceName` (string, required)
  - `ListUsers.response.200.users.slug` (string, required)
  - `ListUsers.response.200.users.source` (string, required)
    - one of `"hosted"`, `"jit"`, `"scim"`
  - `ListUsers.response.200.users.status` (string, required)
    - one of `"active"`, `"suspended"`, `"pendingActivation"`
  - `ListUsers.response.200.users.tags` (map<string>, required)
  - `ListUsers.response.200.users.updatedAt` (string, required)
    - format `date-time`

### 400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListUsers.response.400.error` (object, required)
  - `ListUsers.response.400.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListUsers.response.400.error.message` (string, required)
    - maxLength 1024
  - `ListUsers.response.400.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListUsers.response.400.error.issues.message` (string, required)
    - `ListUsers.response.400.error.issues.path` (string, required)
  - `ListUsers.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListUsers.response.400.error.quota.id` (string, required)
    - `ListUsers.response.400.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListUsers.response.400.error.quota.limit` (integer, required)
      - min 0
    - `ListUsers.response.400.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListUsers.response.400.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListUsers.response.400.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListUsers.response.400.error.quota.region` (string, optional)
    - `ListUsers.response.400.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListUsers.response.400.error.quota.scopeResourceName` (string, optional)
    - `ListUsers.response.400.error.quota.used` (integer, optional)
      - min 0
    - `ListUsers.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 401

unauthenticated: no credential, or one that doesn't check out.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListUsers.response.401.error` (object, required)
  - `ListUsers.response.401.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListUsers.response.401.error.message` (string, required)
    - maxLength 1024
  - `ListUsers.response.401.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListUsers.response.401.error.issues.message` (string, required)
    - `ListUsers.response.401.error.issues.path` (string, required)
  - `ListUsers.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListUsers.response.401.error.quota.id` (string, required)
    - `ListUsers.response.401.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListUsers.response.401.error.quota.limit` (integer, required)
      - min 0
    - `ListUsers.response.401.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListUsers.response.401.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListUsers.response.401.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListUsers.response.401.error.quota.region` (string, optional)
    - `ListUsers.response.401.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListUsers.response.401.error.quota.scopeResourceName` (string, optional)
    - `ListUsers.response.401.error.quota.used` (integer, optional)
      - min 0
    - `ListUsers.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListUsers.response.403.error` (object, required)
  - `ListUsers.response.403.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListUsers.response.403.error.message` (string, required)
    - maxLength 1024
  - `ListUsers.response.403.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListUsers.response.403.error.issues.message` (string, required)
    - `ListUsers.response.403.error.issues.path` (string, required)
  - `ListUsers.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListUsers.response.403.error.quota.id` (string, required)
    - `ListUsers.response.403.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListUsers.response.403.error.quota.limit` (integer, required)
      - min 0
    - `ListUsers.response.403.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListUsers.response.403.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListUsers.response.403.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListUsers.response.403.error.quota.region` (string, optional)
    - `ListUsers.response.403.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListUsers.response.403.error.quota.scopeResourceName` (string, optional)
    - `ListUsers.response.403.error.quota.used` (integer, optional)
      - min 0
    - `ListUsers.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 404

not_found: unknown, malformed, or in an organization the caller isn't in.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListUsers.response.404.error` (object, required)
  - `ListUsers.response.404.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListUsers.response.404.error.message` (string, required)
    - maxLength 1024
  - `ListUsers.response.404.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListUsers.response.404.error.issues.message` (string, required)
    - `ListUsers.response.404.error.issues.path` (string, required)
  - `ListUsers.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListUsers.response.404.error.quota.id` (string, required)
    - `ListUsers.response.404.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListUsers.response.404.error.quota.limit` (integer, required)
      - min 0
    - `ListUsers.response.404.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListUsers.response.404.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListUsers.response.404.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListUsers.response.404.error.quota.region` (string, optional)
    - `ListUsers.response.404.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListUsers.response.404.error.quota.scopeResourceName` (string, optional)
    - `ListUsers.response.404.error.quota.used` (integer, optional)
      - min 0
    - `ListUsers.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListUsers.response.429.error` (object, required)
  - `ListUsers.response.429.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListUsers.response.429.error.message` (string, required)
    - maxLength 1024
  - `ListUsers.response.429.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListUsers.response.429.error.issues.message` (string, required)
    - `ListUsers.response.429.error.issues.path` (string, required)
  - `ListUsers.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListUsers.response.429.error.quota.id` (string, required)
    - `ListUsers.response.429.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListUsers.response.429.error.quota.limit` (integer, required)
      - min 0
    - `ListUsers.response.429.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListUsers.response.429.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListUsers.response.429.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListUsers.response.429.error.quota.region` (string, optional)
    - `ListUsers.response.429.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListUsers.response.429.error.quota.scopeResourceName` (string, optional)
    - `ListUsers.response.429.error.quota.used` (integer, optional)
      - min 0
    - `ListUsers.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 500

internal_error: a bug; the details are in the logs, under the request ID.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListUsers.response.500.error` (object, required)
  - `ListUsers.response.500.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListUsers.response.500.error.message` (string, required)
    - maxLength 1024
  - `ListUsers.response.500.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListUsers.response.500.error.issues.message` (string, required)
    - `ListUsers.response.500.error.issues.path` (string, required)
  - `ListUsers.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListUsers.response.500.error.quota.id` (string, required)
    - `ListUsers.response.500.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListUsers.response.500.error.quota.limit` (integer, required)
      - min 0
    - `ListUsers.response.500.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListUsers.response.500.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListUsers.response.500.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListUsers.response.500.error.quota.region` (string, optional)
    - `ListUsers.response.500.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListUsers.response.500.error.quota.scopeResourceName` (string, optional)
    - `ListUsers.response.500.error.quota.used` (integer, optional)
      - min 0
    - `ListUsers.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 503

unavailable: a dependency the request needs is down. Retry after Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `ListUsers.response.503.error` (object, required)
  - `ListUsers.response.503.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `ListUsers.response.503.error.message` (string, required)
    - maxLength 1024
  - `ListUsers.response.503.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `ListUsers.response.503.error.issues.message` (string, required)
    - `ListUsers.response.503.error.issues.path` (string, required)
  - `ListUsers.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `ListUsers.response.503.error.quota.id` (string, required)
    - `ListUsers.response.503.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `ListUsers.response.503.error.quota.limit` (integer, required)
      - min 0
    - `ListUsers.response.503.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `ListUsers.response.503.error.quota.inFlight` (integer, optional)
      - min 0
    - `ListUsers.response.503.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `ListUsers.response.503.error.quota.region` (string, optional)
    - `ListUsers.response.503.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `ListUsers.response.503.error.quota.scopeResourceName` (string, optional)
    - `ListUsers.response.503.error.quota.used` (integer, optional)
      - min 0
    - `ListUsers.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.


Source: https://docs.ezghcloud.com/sso-api/ListUsers/index.md