Method: folders.search

Search for folders that match specific filter criteria. Search provides an eventually consistent view of the folders a user has access to which meet the specified filter criteria.

This will only return folders on which the caller has the permission resourcemanager.folders.get.

HTTP request

POST https://cloudresourcemanager.googleapis.com/v2/folders:search

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "pageSize": integer,
  "pageToken": string,
  "query": string
}
Fields
pageSize

integer

Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.
pageToken

string

Optional. A pagination token returned from a previous call to folders.search that indicates from where search should continue.
query

string

Search criteria used to select the Folders to return. If no search criteria is specified then all accessible folders will be returned.

Query expressions can be used to restrict results based upon displayName, lifecycleState and parent, where the operators =, NOT, AND and OR can be used along with the suffix wildcard symbol *.

The displayName field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior.

Some example queries are:

  • Query displayName=Test* returns Folder resources whose display name starts with "Test".
  • Query lifecycleState=ACTIVE returns Folder resources with lifecycleState set to ACTIVE.
  • Query parent=folders/123 returns Folder resources that have folders/123 as a parent resource.
  • Query parent=folders/123 AND lifecycleState=ACTIVE returns active Folder resources that have folders/123 as a parent resource.
  • Query displayName=\\"Test String\\" returns Folder resources with display names that include both "Test" and "String".

Response body

The response message for searching folders.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "folders": [
    {
      object (Folder)
    }
  ],
  "nextPageToken": string
}
Fields
folders[]

object (Folder)

A possibly paginated folder search results. the specified parent resource.
nextPageToken

string

A pagination token returned from a previous call to folders.search that indicates from where searching should continue.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/cloudplatformfolders
  • https://www.googleapis.com/auth/cloudplatformfolders.readonly

For more information, see the Authentication Overview.