Search Organizations - Blink Documentation

Basic Parameters
Advanced Parameters
Example Output
Workflow Library Example

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.

External DocumentationTo learn more, visit the GCP documentation.

Basic Parameters

Parameter Description

Query

Parameter	Description
Query	Optional. An optional query string used to filter the Organizations to return in the response. Query rules are case-insensitive. `\| Field \| Description \| \|------------------\|--------------------------------------------\| \| directoryCustomerId, owner.directoryCustomerId \| Filters by directory customer id. \| \| domain \| Filters by domain. \|` Organizations may be queried by `directoryCustomerId` or by `domain`, where the domain is a G Suite domain, for example: * Query `directorycustomerid:123456789` returns Organization resources with `owner.directory_customer_id` equal to `123456789`. * Query `domain:google.com` returns Organization resources corresponding to the domain `google.com`.
Return All Pages	Automatically fetch all resources, page by page.

Optional. An optional query string used to filter the Organizations to return in the response. Query rules are case-insensitive.

| Field | Description | |------------------|--------------------------------------------| | directoryCustomerId, owner.directoryCustomerId | Filters by directory customer id. | | domain | Filters by domain. |

Organizations may be queried by directoryCustomerId or by domain, where the domain is a G Suite domain, for example: * Query directorycustomerid:123456789 returns Organization resources with owner.directory_customer_id equal to 123456789. * Query domain:google.com returns Organization resources corresponding to the domain google.com.

Return All Pages Automatically fetch all resources, page by page.

Advanced Parameters

Parameter	Description
Page Size	Optional. The maximum number of organizations to return in the response. The server can return fewer organizations than requested. If unspecified, server picks an appropriate default.

Example Output

{
	"organizations": [
		{
			"name": "organizations/12345678910",
			"displayName": "example.com",
			"directoryCustomerId": "C022upqx2",
			"state": "ACTIVE",
			"createTime": "2021-02-28T03:43:59.019Z",
			"updateTime": "2021-02-28T03:43:59.795Z",
			"etag": "h1pjxpNSZHoVUXHcowwzdg=="
		}
	]
}