Method: googleapis.cloudresourcemanager.v3.organizations.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

Arguments

Parameters
pageSize	integer (int32 format) 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.
pageToken	string Optional. A pagination token returned from a previous call to SearchOrganizations that indicates from where listing should continue.
query	string 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.

Raised exceptions

Exceptions
ConnectionError	In case of a network problem (such as DNS failure or refused connection).
HttpError	If the response status is >= 400 (excluding 429 and 503).
TimeoutError	If a long-running operation takes longer to finish than the specified timeout limit.
TypeError	If an operation or function receives an argument of the wrong type.
ValueError	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of SearchOrganizationsResponse.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- search:
    call: googleapis.cloudresourcemanager.v3.organizations.search
    args:
        pageSize: ...
        pageToken: ...
        query: ...
    result: searchResult

JSON

[
  {
    "search": {
      "call": "googleapis.cloudresourcemanager.v3.organizations.search",
      "args": {
        "pageSize": "...",
        "pageToken": "...",
        "query": "..."
      },
      "result": "searchResult"
    }
  }
]