ClientService

Batch Get Groups

Retrieves multiple Groups by their resource names in a single request. All names must be in the Organization specified by parent. Maximum of 100 groups can be retrieved per request.

get/v1alpha2/organizations/{organization}/groups:batchGet

Request

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

Path parameters

organizationstring required

The organization identifier of the resource path.

Query parameters

namesstring[] required

The names of the Group to get. Must contain between 1 and 100 names; an empty list or more than 100 is rejected.

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; NAME_ONLY returns just name and display_name.

  • 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.

Changes

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