ClientService

Get Group

Returns the requested Group by its resource name. Optionally includes membership when the FULL view is requested.

get/v1alpha2/organizations/{organization}/groups/{group}

Request

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

Path parameters

organizationstring required

The organization identifier of the resource path.

groupstring required

The group identifier of the resource path.

Query parameters

view'GROUP_VIEW_UNSPECIFIED' | 'GROUP_VIEW_BASIC' | 'GROUP_VIEW_FULL' | 'GROUP_VIEW_NAME_ONLY'

Optional. Specifies which view of the Group resource to return. When unspecified, defaults to BASIC (core fields without membership).

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

namestring

The unique resource name of the group. This field is system-generated and immutable.

displayNamestring required

Human-readable group name.

emailstring

Optional shared contact email address for the group.

notificationBehaviour'NOTIFICATION_BEHAVIOUR_UNSPECIFIED' | 'SEND_TO_GROUP_EMAIL' | 'SEND_TO_MEMBERS' | 'SEND_TO_GROUP_EMAIL_AND_MEMBERS'

Determines where notifications for a Group are delivered.

  • SEND_TO_GROUP_EMAIL: Send notifications to the group's shared email address only.
  • SEND_TO_MEMBERS: Send notifications to every member of the group individually.
  • SEND_TO_GROUP_EMAIL_AND_MEMBERS: Send notifications to both the group's shared email address and every member.
membersstring[]

The member Users of the group.

Changes

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