ClientService

List Groups

Lists Groups for a given Organization. Results can be filtered and support pagination.

get/v1alpha2/organizations/{organization}/groups

Request

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

Path parameters

organizationstring required

The organization identifier of the resource path.

Query parameters

pageSizeinteger

Optional limit on the number of Groups to be returned. If not specified, the default is 25.

pageTokenstring

Optional pagination token, returned earlier via ListGroupsResponse.next_page_token.

filterstring

Only include resources that match this filter in the response. Filtering by the following fields is supported:

  • display_name
  • email
  • resource_name (a resource the group holds a role binding on, e.g. a team)
  • role_name (a role the group holds) For more information, see FilterSyntax
view'GROUP_VIEW_UNSPECIFIED' | 'GROUP_VIEW_BASIC' | 'GROUP_VIEW_FULL' | 'GROUP_VIEW_NAME_ONLY'

Optional. Specifies which view of the Group resources to return. When unspecified, defaults to BASIC. FULL additionally returns membership and role bindings.

  • GROUP_VIEW_UNSPECIFIED: Default value. When used, defaults to BASIC view.
  • GROUP_VIEW_BASIC: Basic view: core group fields without membership queries.

Includes:

  • name: The unique resource identifier

  • display_name: Human-readable group name

  • email: Group contact email

  • notification_behaviour: How notifications are routed

  • GROUP_VIEW_FULL: Full view: BASIC plus the membership list and the group's role bindings.

Includes:

  • All BASIC fields

  • members: The group's member users

  • role_bindings: The roles the group holds (inherited by its members)

  • GROUP_VIEW_NAME_ONLY: Name-only view exposes just enough to identify a group, for callers who may list an organisation's group names but nothing more about them (e.g. the group pickers in team settings). It is a strict subset of BASIC.

Includes:

  • name: The unique resource identifier
  • display_name: Human-readable group name

Response

A successful response.

nextPageTokenstring

A token to retrieve the next page of results. Pass this value in ListGroupsRequest.page_token to retrieve the next page of results.

Changes

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