gcloud alpha recaptcha keys update

NAME
gcloud alpha recaptcha keys update - update a Key
SYNOPSIS
gcloud alpha recaptcha keys update KEY [--display-name=DISPLAY_NAME] [--labels=[KEY=VALUE,…]] [--express     | --android (--allow-all-package-names | --package-names=[PACKAGE_NAMES,…])     | [--ios : --allow-all-bundle-ids | --bundle-ids=[BUNDLE_IDS,…] --key-id=KEY_ID --private-key-file=PATH_TO_FILE --team-id=TEAM_ID]     | [--web : --allow-amp-traffic --security-preference=SECURITY_PREFERENCE --allow-all-domains | --domains=[DOMAINS,…]]] [GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA) Update a reCAPTCHA Key.
EXAMPLES
To update the information of a reCAPTCHA key, run:
gcloud alpha recaptcha keys update test-key --labels="foo=bar" --web --domains=test.com.mx
POSITIONAL ARGUMENTS
Key resource - The reCAPTCHA Key to update. This represents a Cloud resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways.

To set the project attribute:

  • provide the argument key on the command line with a fully specified name;
  • provide the argument --project on the command line;
  • set the property core/project.

This must be specified.

KEY
ID of the key or fully qualified identifier for the key.

To set the key attribute:

  • provide the argument key on the command line.
FLAGS
--display-name=DISPLAY_NAME
A human-readable name for the key. Typically a site or app name.
--labels=[KEY=VALUE,…]
List of label KEY=VALUE pairs to add.
At most one of these can be specified:
Options for the creation of a site key for Express.
--express
Creates a Key configured for Express assessments.
Options for the creation of a site key for Android.
--android
Creates a Key configured for Android devices.

This flag argument must be specified if any of the other arguments in this group are specified.

Exactly one of these must be specified:
--allow-all-package-names
If set, package name enforcement will NOT be enabled on this key.
--package-names=[PACKAGE_NAMES,…]
Android package names of apps allowed to use the key.

Example of a valid package name: 'com.companyname.appname'

Options for the creation of a site key for iOS.
--ios
Creates a Key configured for iOS devices.

This flag argument must be specified if any of the other arguments in this group are specified.

At most one of these can be specified:
--allow-all-bundle-ids
If set, bundle id enforcement will NOT be enabled on this key.
--bundle-ids=[BUNDLE_IDS,…]
iOS bundle ids of apps allowed to use the key.

Example of a valid bundle id: 'com.companyname.productname.appname'

Fields that are required to perform Apple-specific integrity checks (recommended for iOS keys).
--key-id=KEY_ID
The Apple developer key ID (10-character string).

This flag argument must be specified if any of the other arguments in this group are specified.

--private-key-file=PATH_TO_FILE
File path to a private key (downloaded as a text file with a .p8 file extension) generated for your Apple Developer account. Ensure that DeviceCheck is enabled for the private key. Use a full or relative path to a local file containing the value of private_key_file.

This flag argument must be specified if any of the other arguments in this group are specified.

--team-id=TEAM_ID
The Apple team ID (10-character string) owning the provisioning profile used to build your application.

This flag argument must be specified if any of the other arguments in this group are specified.

Options for the creation of a site key for web.
--web
Creates a Key configured for websites.

This flag argument must be specified if any of the other arguments in this group are specified.

--allow-amp-traffic
Whether this key can be used on AMP (Accelerated Mobile Pages) websites.
--security-preference=SECURITY_PREFERENCE
Represents the possible challenge frequency and difficulty configurations for a web key. usability: show fewer and easier challenges. balance: show balanced (in amount and difficulty) challenges. security: show more and harder challenges.

SECURITY_PREFERENCE must be one of: balance, challenge-security-preference-unspecified, security, usability.

At most one of these can be specified:
--allow-all-domains
If set, domain name enforcement will NOT be enabled on this key.
--domains=[DOMAINS,…]
Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment.

Examples of valid domains: 'example.com' 'subdomain.example.com'

GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.

Run $ gcloud help for details.

API REFERENCE
This command uses the recaptchaenterprise/v1 API. The full documentation for this API can be found at: https://cloud.google.com/recaptcha-enterprise/
NOTES
This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist. This variant is also available:
gcloud recaptcha keys update