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

ProjectsAppsRecaptchaV3Config

class ProjectsAppsRecaptchaV3Config extends Resource (View source)

The "recaptchaV3Config" collection of methods.

Typical usage is:

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

Methods

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

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

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

Gets the RecaptchaV3Config for the specified app. For security reasons, the site_secret field is never populated in the response.

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

Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA V3 tokens for App Check tokens. For security reasons, the site_secret field is never populated in the response. (recaptchaV3Config.patch)

Details

at line 52
GoogleFirebaseAppcheckV1BatchGetRecaptchaV3ConfigsResponse batchGet(string $parent, array $optParams = [])

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

(recaptchaV3Config.batchGet)

Parameters

string $parent

Required. The parent project name shared by all RecaptchaV3Configs 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

GoogleFirebaseAppcheckV1BatchGetRecaptchaV3ConfigsResponse

Exceptions

Exception

at line 70
GoogleFirebaseAppcheckV1RecaptchaV3Config get(string $name, array $optParams = [])

Gets the RecaptchaV3Config for the specified app. For security reasons, the site_secret field is never populated in the response.

(recaptchaV3Config.get)

Parameters

string $name

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

Optional parameters.

Return Value

GoogleFirebaseAppcheckV1RecaptchaV3Config

Exceptions

Exception

at line 93
GoogleFirebaseAppcheckV1RecaptchaV3Config patch(string $name, GoogleFirebaseAppcheckV1RecaptchaV3Config $postBody, array $optParams = [])

Updates the RecaptchaV3Config for the specified app. While this configuration is incomplete or invalid, the app will be unable to exchange reCAPTCHA V3 tokens for App Check tokens. For security reasons, the site_secret field is never populated in the response. (recaptchaV3Config.patch)

Parameters

string $name

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

Optional parameters.

Return Value

GoogleFirebaseAppcheckV1RecaptchaV3Config

Exceptions

Exception