1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Firebaseappcheck
  7. \
  8. Resource
  9. \
  10. ProjectsAppsRecaptchaConfig

ProjectsAppsRecaptchaConfig

class ProjectsAppsRecaptchaConfig extends Resource (View source)

The "recaptchaConfig" collection of methods.

Typical usage is:

 $firebaseappcheckService = new Google\Service\Firebaseappcheck(...);
 $recaptchaConfig = $firebaseappcheckService->recaptchaConfig;

Methods

GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse
batchGet(string $parent, array $optParams = [])

Atomically gets the RecaptchaConfigs for the specified list of apps. For security reasons, the site_secret field is never populated in the response.

GoogleFirebaseAppcheckV1betaRecaptchaConfig
get(string $name, array $optParams = [])

Gets the RecaptchaConfig for the specified app. For security reasons, the site_secret field is never populated in the response. (recaptchaConfig.get)

GoogleFirebaseAppcheckV1betaRecaptchaConfig
patch(string $name, GoogleFirebaseAppcheckV1betaRecaptchaConfig $postBody, array $optParams = [])

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 site_secret field is never populated in the response. (recaptchaConfig.patch)

Details

at line 50
GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse batchGet(string $parent, array $optParams = [])

Atomically gets the RecaptchaConfigs for the specified list of apps. For security reasons, the site_secret field is never populated in the response.

(recaptchaConfig.batchGet)

Parameters

string $parent

Required. The parent project name shared by all RecaptchaConfigs being retrieved, in the format projects/{project_number} The parent collection in the name field of any resource being retrieved must match this field, or the entire batch fails.
array $optParams

Optional parameters.

Return Value

GoogleFirebaseAppcheckV1betaBatchGetRecaptchaConfigsResponse

at line 66
GoogleFirebaseAppcheckV1betaRecaptchaConfig get(string $name, array $optParams = [])

Gets the RecaptchaConfig for the specified app. For security reasons, the site_secret field is never populated in the response. (recaptchaConfig.get)

Parameters

string $name

Required. The relative resource name of the RecaptchaConfig, in the format: projects/{project_number}/apps/{app_id}/recaptchaConfig
array $optParams

Optional parameters.

Return Value

GoogleFirebaseAppcheckV1betaRecaptchaConfig

at line 88
GoogleFirebaseAppcheckV1betaRecaptchaConfig patch(string $name, GoogleFirebaseAppcheckV1betaRecaptchaConfig $postBody, array $optParams = [])

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 site_secret field is never populated in the response. (recaptchaConfig.patch)

Parameters

string $name

Required. The relative resource name of the reCAPTCHA v3 configuration object, in the format: projects/{project_number}/apps/{app_id}/recaptchaConfig
GoogleFirebaseAppcheckV1betaRecaptchaConfig $postBody
array $optParams

Optional parameters.

Return Value

GoogleFirebaseAppcheckV1betaRecaptchaConfig