Method: projects.updateAutokeyConfig

Full name: projects.updateAutokeyConfig

Updates theAutokeyConfig for a folder or a project. The caller must have bothcloudkms.autokeyConfigs.update permission on the parent folder andcloudkms.cryptoKeys.setIamPolicy permission on the provided key project. AKeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resultingCryptoKey.

HTTP request


PATCH https://cloudkms.googleapis.com/v1/{autokeyConfig.name=projects/*/autokeyConfig}

The URLs usegRPC Transcoding syntax.

Path parameters

Parameters
autokeyConfig.name

string

Identifier. Name of theAutokeyConfig resource, e.g.folders/{FOLDER_NUMBER}/autokeyConfig orprojects/{PROJECT_NUMBER}/autokeyConfig.

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Masks which fields of theAutokeyConfig to update, e.g.keyProject.

This is a comma-separated list of fully qualified names of fields. Example:"user.displayName,photo".

Request body

The request body contains an instance ofAutokeyConfig.

Response body

If successful, the response body contains an instance ofAutokeyConfig.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudkms
  • https://www.googleapis.com/auth/cloud-platform

For more information, see theAuthentication Overview.

IAM Permissions

Requires the followingIAM permission on thename resource:

  • cloudkms.autokeyConfigs.update

For more information, see theIAM documentation.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-11 UTC.