Method: projects.apps.recaptchaConfig.patch

Updates the RecaptchaConfig for the specified app.

While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA tokens for App Check tokens.

For security reasons, the siteSecret field is never populated in the response.

HTTP request

PATCH https://firebaseappcheck.googleapis.com/v1beta/{recaptchaConfig.name=projects/*/apps/*/recaptchaConfig}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
recaptchaConfig.name

string

Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format:

projects/{project_number}/apps/{app_id}/recaptchaConfig

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. A comma-separated list of names of fields in the RecaptchaConfig to update. Example: siteSecret.

Request body

The request body contains an instance of RecaptchaConfig.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.