ClientService

List Users

Lists Users within the specified organization. Results are paginated and can be filtered. Listing users across all organizations the caller has access to is supported by setting the parent to organizations/-.

get/v1/organizations/{organization}/users

Request

  • Base URL: https://api.thirdfort.dev/client/api
  • URL: https://api.thirdfort.dev/client/api/v1/organizations/{organization}/users
  • Auth: HTTP bearer

Path parameters

organizationstring required

The organization identifier of the resource path.

Query parameters

pageSizeinteger

Optional. The maximum number of users to return per page. If not specified, a default value of 25 will be used. Maximum allowed value is 100; larger values are capped at 100 rather than rejected.

pageTokenstring

Optional. A page token, received from a previous ListUsers call. Provide this token to retrieve the subsequent page. When not provided, returns the first page of results.

filterstring

Optional. Filter expression to limit the users returned in the response. Filtering by the following fields is supported:

  • email: Filter by email address
  • display_name: Filter by display name
  • state: Filter by user state (ACTIVE, INACTIVE, INVITED, DELETED)

Maximum length 2000 bytes (the limit is measured in UTF-8 bytes, not characters).

For more information, see FilterSyntax

showDeletedboolean

Optional. Whether to include soft-deleted users in the results. Defaults to false.

Response

A successful response.

nextPageTokenstring

A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent request to retrieve the next page. This field will be empty if there are no more results to retrieve.

Changes

No recorded changes to this operation across all 1 revision of this API.