v22

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-01140308542.4 KB
Users

List users

Returns a list of users in the specified zone.

Rollout note: the paginated/searchable/sortable behavior described below is gated behind the user-pagination feature flag and is currently disabled for most zones. While the flag is off, the response returns every user in the zone (capped at 100) in items and a fixed pagination envelope where after_cursor and before_cursor are null and total_count is 0. The query parameters below are accepted but ignored. The flag is rolled out per-zone in Datadog and will become the default once Console adopts the paginated contract.

Use cursor pagination via after/before. Sort: comma-separated field list; prefix with - for descending. Use expand[]=total_count to include the matching row count, expand[]=session_count to include per-user session counts, expand[]=grant_count to include per-user delegated-grant counts, and expand[]=role-assignments to include each user's structured role grants. Filter by exact email via filter[email]; search via query[email] / query[subject] / query[] (substring match, OR'd across repeated values). query[] matches against email and federation credential subject. Pass filter[id] (repeatable, max 100) to restrict results to a known set of users — mutually exclusive with after/before (returns 400 if combined). When filter[id] is set, limit is ignored and the response contains every requested user that exists in the zone, in a single page. IDs not in the zone are silently omitted.

get/zones/{zoneId}/users

Path parameters

zoneIdstring required

Zone ID

Query parameters

afterstring

Cursor for forward pagination

beforestring

Cursor for backward pagination

limitinteger

Maximum number of items to return

'total_count' | 'session_count' | 'grant_count' | 'role-assignments'
OR
string[]
string email

Filter by exact email address

OR
string[]
string

Restrict results to users with this publicId. Repeatable, max 100. Mutually exclusive with after/before.

OR
string[]
string

Search by email (substring match)

OR
string[]
string

Search by federated credential subject (substring match)

OR
string[]
string

Search across email and credential subject (substring match)

OR
string[]
sortstring

Comma-separated sort fields. Prefix with - for descending. Allowed: created_at, email, authenticated_at

Response

Default Response