GOgoogle
folders

GET /v3/folders/{foldersId}

Changed on

Retrieves a folder identified by the supplied resource name. Valid folder resource names have the format folders/{folder_id} (for example, folders/1234). The caller must have resourcemanager.folders.get permission on the identified folder.

Request

  • Base URL
    https://cloudresourcemanager.googleapis.com
  • URL
    https://cloudresourcemanager.googleapis.com/v3/folders/{foldersId}
  • Auth
    • OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/cloud-platform
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform
    • or OAuth 2 and OAuth 2
      Implicit: https://accounts.google.com/o/oauth2/auth
      Scopes: https://www.googleapis.com/auth/cloud-platform.read-only
      Authorization code: https://accounts.google.com/o/oauth2/auth
      Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform.read-only

Path parameters

foldersIdstring required

Response

Successful response

configuredCapabilitiesstring[]

Output only. Optional capabilities configured for this folder (via UpdateCapability API). Example: folders/123/capabilities/app-management.

createTimestring google-datetime

Output only. Timestamp when the folder was created.

deleteTimestring google-datetime

Output only. Timestamp when the folder was requested to be deleted.

displayNamestring

The folder's display name. A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: [\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?.

etagstring

Output only. A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

managementProjectstring

Output only. Management Project associated with this folder (if app-management capability is enabled). Example: projects/google-mp-123 OUTPUT ONLY.

namestring

Identifier. The resource name of the folder. Its format is folders/{folder_id}, for example: "folders/1234".

parentstring

Required. The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder.

state'STATE_UNSPECIFIED' | 'ACTIVE' | 'DELETE_REQUESTED'

Output only. The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder.

tagsobject

Optional. Input only. Immutable. Tag keys/values directly bound to this folder. Each item in the map must be expressed as " : ". For example: "123/environment" : "production", "123/costCenter" : "marketing" Note: Currently this field is in Preview.

updateTimestring google-datetime

Output only. Timestamp when the folder was last modified.

Changes

  • 9e107eeb58dfRevision changes
    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform.read-only was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/cloud-platform.read-only was removed from the endpoint's security scheme Oauth2c