List Organisations
const url = 'https://example.com/taxonomy/v1/organisations';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/taxonomy/v1/organisationsReturns a paginated list of organisations
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”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.
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.
AIP-160 filter expression.
Partial matches (:, a quoted wildcard, contains/startsWith/endsWith) ignore capitalisation; = and the relational operators are exact.
Filterable fields: create_time, display_name, id, name, owner_user_id, state, state_origin, update_time.
AIP-132 order_by expression. Sortable fields: create_time, display_name, name, state, state_origin, update_time.
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).
Also count the whole subtree: every group and workspace at any depth below each listed organisation, reported in child_scope_counts.descendant. When this field is not set, only the direct counts are computed.
Responses
Section titled “ Responses ”OK
ListOrganisationsResponse
Response message for ListOrganisations.
object
The list of organisations
Organisation resource
object
The unique identifier of the organisation
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.
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.
The user ID of the organisation owner (weak reference to iam.users)
Created Timestamp
The timestamp when the organisation was created
Updated Timestamp
Timestamp when the Organisation was last updated
Lifecycle State
This organisation’s own lifecycle state. Changed only through the lifecycle verbs, never by update.
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.
Archived Timestamp
The instant the organisation entered the archived state. Unset unless the organisation is archived.
State Origin
Whether the current state was set directly on this resource or cascaded from an ancestor. Provenance for audit and display.
Child Scope Counts
Counts of the groups and workspaces inside this organisation, split by lifecycle state.
object
Immediate children only, one level down. Always present.
object
How many children are active.
How many children are suspended. A suspended child still exists and can be opened.
How many children are archived. Archiving is the soft delete, so these are normally hidden from a listing.
Every group and workspace at any depth below this organisation or group, not counting the organisation or group itself.
Absent unless the request set include_descendant_counts. An absent block means the subtree was not asked for; a present block of zeros means it was asked for and is empty. The two are different answers and are reported differently.
object
How many children are active.
How many children are suspended. A suspended child still exists and can be opened.
How many children are archived. Archiving is the soft delete, so these are normally hidden from a listing.
A token, which can be sent as page_token to retrieve the next page.
If this field is empty, there are no subsequent pages.
Exact count of resources matching the request’s filter and scope (both pagination modes).
Example
{ "organisations": [ { "state": "TAXONOMY_RESOURCE_STATE_UNSPECIFIED", "effective_state": "TAXONOMY_RESOURCE_STATE_UNSPECIFIED", "state_origin": "TAXONOMY_STATE_CHANGE_ORIGIN_UNSPECIFIED" } ]}default
Section titled “default ”Default error response
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
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
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.
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
object
The type of the serialized message.
Example generated
{ "code": 1, "message": "example", "details": [ { "@type": "example" } ]}