Method: projects.keys.patch

Updates the specified key.

HTTP request

PATCH https://recaptchaenterprise.googleapis.com/v1/{key.name=projects/*/keys/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
key.name

string

The resource name for the Key in the format "projects/{project}/keys/{key}".

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. The mask to control which fields of the key get updated. If the mask is not present, all fields will be updated.

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

Request body

The request body contains an instance of Key.

Response body

If successful, the response body contains an instance of Key.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • recaptchaenterprise.keys.update

For more information, see the IAM documentation.