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
GET https://cloudresourcemanager.googleapis.com/v3/folders:search
The URL uses gRPC Transcoding syntax.
Query parameters
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
Optional. 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, state 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.
| Field | Description |
|-------------------------|----------------------------------------|
| displayName | Filters by displayName. |
| parent | Filters by parent (for example: folders/123). |
| state, lifecycleState | Filters by state. |
Some example queries are:
- Query
displayName=Test*returns Folder resources whose display name starts with "Test". - Query
state=ACTIVEreturns Folder resources withstateset toACTIVE. - Query
parent=folders/123returns Folder resources that havefolders/123as a parent resource. - Query
parent=folders/123 AND state=ACTIVEreturns active Folder resources that havefolders/123as a parent resource. - Query
displayName=\\"Test String\\"returns Folder resources with display names that include both "Test" and "String".
Request body
The request body must be empty.
Response body
The response message for searching folders.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"folders"
:
[
{
object (
|
| Fields | |
|---|---|
folders[]
|
A possibly paginated folder search results. the specified parent resource. |
nextPageToken
|
A pagination token returned from a previous call to |
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 .
