Lists Users that the authenticated user has permission to view.
Results can be filtered by email, display name, or organization. Supports pagination and optionally includes role bindings for each user.
Request
- Base URL: https://api.thirdfort.dev/client/api
- URL: https://api.thirdfort.dev/client/api/v1alpha2/organizations/{organization}/users
- Auth: HTTP bearer
Path parameters
The organization identifier of the resource path.
Query parameters
Optional limit on the number of Users to be returned. If not specified, the default is 25. Maximum allowed value is 100; larger values are capped at 100 rather than rejected.
Optional pagination token, returned earlier via ListUsersResponse.next_page_token.
Only include resources that match this filter in the response. Filtering by the following fields is supported:
- display_name
- organization_name
- state
- resource_name (will match on any role binding for the user)
- role_name (will match on any role binding for the user)
Maximum length 2000 bytes (the limit is measured in UTF-8 bytes, not characters).
For more information, see FilterSyntax
Optional. Specifies which view of the User resources to return. When unspecified, defaults to BASIC view which includes core user fields without expensive computations like role binding queries.
Performance implications:
- BASIC: Fast response, minimal database queries per user
- FULL: Significantly slower for large lists due to role binding queries
Recommended: Use BASIC for user lists, FULL only when role information is required.
-
USER_VIEW_UNSPECIFIED: Default value. When used, defaults to BASIC view. This ensures backward compatibility for clients not specifying a view.
-
USER_VIEW_BASIC: Basic view includes core user information without expensive computations. This view provides essential user data needed for most operations while avoiding performance overhead from related resource queries.
Includes:
-
name: The unique resource identifier
-
email: User's email address
-
display_name: Human-readable user name
-
state: Current operational state (ACTIVE, INACTIVE, etc.)
-
last_seen: Timestamp of last API interaction
-
authentication_provider_type: Authentication method used
-
is_deleted: Soft-deletion status
-
new_notification_recipient: Notification inheritance on deletion
-
delete_time: Soft-deletion timestamp
-
USER_VIEW_FULL: Full view includes all available user information including related resources. This view should be used when complete user context is required, such as for detailed user management operations or comprehensive user profiles.
Includes:
-
All BASIC fields
-
role_bindings: Complete list of role assignments and permissions
-
USER_VIEW_NAME_ONLY: Name-only view exposes just enough to identify a user, for callers who may see who a user is but nothing more about them (e.g. cross-org secure-share viewers). It is a strict subset of BASIC.
Includes:
- name: The unique resource identifier
- display_name: Human-readable user name
- email: User's email address
Optional. Whether to include soft-deleted users in the results. Defaults to false.
Response
A successful response.
Changes
No recorded changes to this operation across all 1 revision of this API.