List Organisations

GET

/taxonomy/v1/organisations

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

Returns a paginated list of organisations

Parameters

Query Parameters

page_size

integer format: int32

The maximum number of organisations to return. The service may return fewer than this value. If unspecified, at most 20 organisations will be returned. The maximum value is 100; values above 100 will be coerced to 100.

page_token

string

A page token, received from a previous ListOrganisations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListOrganisations must match the call that provided the page token.

filter

string

AIP-160 filter expression. Filterable fields: create_time, display_name, id, name, owner_user_id, state, state_origin, update_time.

order_by

string

AIP-132 order_by expression. Sortable fields: create_time, display_name, name, state, state_origin, update_time.

skip

string

AIP-158 offset mode: number of resources to skip from the start of the filtered, sorted set. Use EITHER skip (offset paging) OR page_token (cursor paging) — never both in the same request. Supplying both is an invalid request. Default 0 (no skip).

Responses

200

OK

Media type application/json

ListOrganisationsResponse

Response message for ListOrganisations.

object

organisations

The list of organisations

Array<object>

Organisation resource

object

id

The unique identifier of the organisation

stringOutput only

name

required

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

string

display_name

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

string

owner_user_id

required

The user ID of the organisation owner (weak reference to iam.users)

string

create_time

Created Timestamp

The timestamp when the organisation was created

string format: date-time Output only

update_time

Updated Timestamp

Timestamp when the Organisation was last updated

string format: date-time Output only

state

Lifecycle State

This organisation’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 organisation actually experiences. An organisation is the root of the hierarchy, so its effective state always equals its own state; the field is carried for a uniform shape across taxonomy resources.

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 organisation entered the archived state. Unset unless the organisation 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

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages.

string

total_size

Exact count of resources matching the request’s filter and scope (both pagination modes).

string

Example

{
  "organisations": [
    {
      "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"
    }
  ]
}