Get Group

GET

/taxonomy/v1/organisations/{organisation}/groups/{id}

curl --request GET \
  --url https://example.com/taxonomy/v1/organisations/example/groups/example

Returns a group by unique ID within an organisation

Parameters

Path Parameters

organisation

required

string

The organisation the group belongs to, or ”-” (AIP-159) to read across organisations. Callers using ”-” must have the required permission at a scope covering the resolved group (typically GROUP(id) or higher).

id

required

string

The unique identifier of the group to retrieve

Responses

200

OK

Media type application/json

Group resource: a folder that organises workspaces within an organisation

object

id

The unique identifier of the group

stringOutput only

organisation_id

The organisation this group belongs to

stringOutput only

name

required

The handle of the group, e.g. “platform-team”. Lowercase letters, digits and hyphens; letter-initial; no adjacent hyphens. Parent-scoped-unique. Used to address the group by name or id.

string

display_name

A human-readable label for the group, e.g. “Platform Team”. Free text in any script. Never used to address the group. Optional; defaults to the handle (name) when omitted.

string

description

An optional description of the group

string

parent_group_id

Optional self-referential parent; empty = root-level group under the organisation

string

create_time

Created Timestamp

The timestamp when the group was created

string format: date-time Output only

update_time

Updated Timestamp

Timestamp when the group was last updated

string format: date-time Output only

state

Lifecycle State

This group’s own lifecycle state. Changed only through the lifecycle verbs, never by update.

string format: enum Output only

Allowed values: TAXONOMY_RESOURCE_STATE_UNSPECIFIED TAXONOMY_RESOURCE_STATE_ACTIVE TAXONOMY_RESOURCE_STATE_SUSPENDED TAXONOMY_RESOURCE_STATE_ARCHIVED

effective_state

Effective Lifecycle State

The state this group actually experiences, accounting for suspension inherited from its parent groups or organisation. A group whose own state is active reports an effective state of suspended while any ancestor is suspended. An archived group always reports archived.

string format: enum Output only

Allowed values: TAXONOMY_RESOURCE_STATE_UNSPECIFIED TAXONOMY_RESOURCE_STATE_ACTIVE TAXONOMY_RESOURCE_STATE_SUSPENDED TAXONOMY_RESOURCE_STATE_ARCHIVED

archive_time

Archived Timestamp

The instant the group entered the archived state. Unset unless the group is archived.

string format: date-time Output only

state_origin

State Origin

Whether the current state was set directly on this resource or cascaded from an ancestor. Provenance for audit and display.

string format: enum Output only

Allowed values: TAXONOMY_STATE_CHANGE_ORIGIN_UNSPECIFIED TAXONOMY_STATE_CHANGE_ORIGIN_DIRECT TAXONOMY_STATE_CHANGE_ORIGIN_INDIRECT

Example

{
  "state": "TAXONOMY_RESOURCE_STATE_UNSPECIFIED",
  "effective_state": "TAXONOMY_RESOURCE_STATE_UNSPECIFIED",
  "state_origin": "TAXONOMY_STATE_CHANGE_ORIGIN_UNSPECIFIED"
}

default

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}