2024-05-04
▼ ▲ cloudkms.folders.updateAutokeyConfig
Path: v1/{+name}
Flat Path: v1/folders/{foldersId}/autokeyConfig
HTTP Method: PATCH
Parameters:
name
Description: Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`.
Pattern: ^folders/[^/]+/autokeyConfig$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes:
Description: Updates the AutokeyConfig for a folder. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. An empty key project may be provided to clear the configuration.
▼ ▲ cloudkms.folders.getAutokeyConfig
Path: v1/{+name}
Flat Path: v1/folders/{foldersId}/autokeyConfig
HTTP Method: GET
Parameters:
name
Description: Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`.
Pattern: ^folders/[^/]+/autokeyConfig$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Returns the AutokeyConfig for a folder.
▼ ▲ cloudkms.projects.showEffectiveAutokeyConfig
Path: v1/{+parent}:showEffectiveAutokeyConfig
Flat Path: v1/projects/{projectsId}:showEffectiveAutokeyConfig
HTTP Method: GET
Parameters:
parent
Description: Required. Name of the resource project to the show effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project.
Pattern: ^projects/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: parent
Scopes:
Description: Returns the effective Cloud KMS Autokey configuration for a given project.
▼ ▲ cloudkms.projects.locations.operations.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method: GET
Parameters:
name
Description: The name of the operation resource.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ cloudkms.projects.locations.keyHandles.create
Path: v1/{+parent}/keyHandles
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/keyHandles
HTTP Method: POST
Parameters:
parent
Description: Required. Name of the resource project and location to create the KeyHandle in, e.g. `projects/{PROJECT_ID}/locations/{LOCATION}`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
keyHandleId
Description: Optional. Id of the KeyHandle. Must be unique to the resource project and location. If not provided by the caller, a new UUID is used.
Location: query
Type: string
Parameter Order: parent
Scopes:
Description: Creates a new KeyHandle, triggering the provisioning of a new CryptoKey for CMEK use with the given resource type in the configured key project and the same location. GetOperation should be used to resolve the resulting long-running operation and get the resulting KeyHandle and CryptoKey.
▼ ▲ cloudkms.projects.locations.keyHandles.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/keyHandles/{keyHandlesId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of the KeyHandle resource, e.g. `projects/{PROJECT_ID}/locations/{LOCATION}/keyHandles/{KEY_HANDLE_ID}`.
Pattern: ^projects/[^/]+/locations/[^/]+/keyHandles/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Returns the KeyHandle.
▼ ▲ cloudkms.projects.locations.keyHandles.list
Path: v1/{+parent}/keyHandles
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/keyHandles
HTTP Method: GET
Parameters:
parent
Description: Required. Name of the resource project and location from which to list KeyHandles, e.g. `projects/{PROJECT_ID}/locations/{LOCATION}`.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
filter
Description: Optional. Filter to apply when listing KeyHandles, e.g. `resource_type_selector="{SERVICE}.googleapis.com/{TYPE}"`.
Location: query
Type: string
Parameter Order: parent
Scopes:
Description: Lists KeyHandles.