organizations
Creates, updates, deletes, gets or lists an organizations resource.
Overview
| Name | organizations |
| Type | Resource |
| Id | google.cloudresourcemanager.organizations |
Fields
The following fields are returned by SELECT queries:
- get
Successful response
| Name | Datatype | Description |
|---|---|---|
name | string | Output only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234". |
createTime | string (google-datetime) | Output only. Timestamp when the Organization was created. |
deleteTime | string (google-datetime) | Output only. Timestamp when the Organization was requested for deletion. |
directoryCustomerId | string | Immutable. The G Suite / Workspace customer id used in the Directory API. |
displayName | string | Output only. A human-readable string that refers to the organization in the Google Cloud Console. This string is set by the server and cannot be changed. The string will be set to the primary domain (for example, "google.com") of the Google Workspace customer that owns the organization. |
etag | string | Output only. A checksum computed by the server based on the current value of the Organization resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. |
state | string | Output only. The organization's current lifecycle state. |
updateTime | string (google-datetime) | Output only. Timestamp when the Organization was last modified. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | organizationsId | Fetches an organization resource identified by the specified resource name. | |
search | exec | pageSize, pageToken, query | Searches organization resources that are visible to the user and satisfy the specified filter. This method returns organizations in an unspecified order. New organizations do not necessarily appear at the end of the results, and may take a small amount of time to appear. Search will only return organizations on which the user has the permission resourcemanager.organizations.get or has super admin privileges. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
organizationsId | string | |
pageSize | integer (int32) | |
pageToken | string | |
query | string |
SELECT examples
- get
Fetches an organization resource identified by the specified resource name.
SELECT
name,
createTime,
deleteTime,
directoryCustomerId,
displayName,
etag,
state,
updateTime
FROM google.cloudresourcemanager.organizations
WHERE organizationsId = '{{ organizationsId }}' -- required;
Lifecycle Methods
- search
Searches organization resources that are visible to the user and satisfy the specified filter. This method returns organizations in an unspecified order. New organizations do not necessarily appear at the end of the results, and may take a small amount of time to appear. Search will only return organizations on which the user has the permission resourcemanager.organizations.get or has super admin privileges.
EXEC google.cloudresourcemanager.organizations.search
@pageSize='{{ pageSize }}',
@pageToken='{{ pageToken }}',
@query='{{ query }}';