.TH "GCLOUD_RECAPTCHA_KEYS_UPDATE" 1



.SH "NAME"
.HP
gcloud recaptcha keys update \- update a Key



.SH "SYNOPSIS"
.HP
\f5gcloud recaptcha keys update\fR \fIKEY\fR [\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-express\fR\ |\ \fB\-\-android\fR\ (\fB\-\-allow\-all\-package\-names\fR\ |\ \fB\-\-package\-names\fR=[\fIPACKAGE_NAMES\fR,...])\ |\ [\fB\-\-ios\fR\ :\ \fB\-\-allow\-all\-bundle\-ids\fR\ |\ \fB\-\-bundle\-ids\fR=[\fIBUNDLE_IDS\fR,...]\ \fB\-\-key\-id\fR=\fIKEY_ID\fR\ \fB\-\-private\-key\-file\fR=\fIPATH_TO_FILE\fR\ \fB\-\-team\-id\fR=\fITEAM_ID\fR]\ |\ [\fB\-\-web\fR\ :\ \fB\-\-allow\-amp\-traffic\fR\ \fB\-\-security\-preference\fR=\fISECURITY_PREFERENCE\fR\ \fB\-\-action\-score\-thresholds\fR=[\fIACTION_SCORE_THRESHOLDS\fR,...]\ \fB\-\-default\-score\-threshold\fR=\fIDEFAULT_SCORE_THRESHOLD\fR\ \fB\-\-allow\-all\-domains\fR\ |\ \fB\-\-domains\fR=[\fIDOMAINS\fR,...]]] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Update a reCAPTCHA Key.



.SH "EXAMPLES"

To update the information of a reCAPTCHA key, run:

.RS 2m
$ gcloud recaptcha keys update test\-key \-\-labels="foo=bar" \-\-web \e
    \-\-domains=test.com.mx
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5key\fR on the command line with a fully specified name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIKEY\fR

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

To set the \f5key\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5key\fR on the command line.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR

A human\-readable name for the key. Typically a site or app name.

.TP 2m
\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to add.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m

Options for the creation of a site key for Express.



.RS 2m
.TP 2m
\fB\-\-express\fR

Creates a Key configured for Express assessments.

.RE
.sp
.TP 2m

Options for the creation of a site key for Android.



.RS 2m
.TP 2m
\fB\-\-android\fR

Creates a Key configured for Android devices.

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

.TP 2m

Exactly one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-allow\-all\-package\-names\fR

If set, package name enforcement will NOT be enabled on this key.

.TP 2m
\fB\-\-package\-names\fR=[\fIPACKAGE_NAMES\fR,...]

Android package names of apps allowed to use the key.

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

.RE
.RE
.sp
.TP 2m

Options for the creation of a site key for iOS.



.RS 2m
.TP 2m
\fB\-\-ios\fR

Creates a Key configured for iOS devices.

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

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-allow\-all\-bundle\-ids\fR

If set, bundle id enforcement will NOT be enabled on this key.

.TP 2m
\fB\-\-bundle\-ids\fR=[\fIBUNDLE_IDS\fR,...]

iOS bundle ids of apps allowed to use the key.

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

.RE
.sp
.TP 2m

Fields that are required to perform Apple\-specific integrity checks
(recommended for iOS keys).



.RS 2m
.TP 2m
\fB\-\-key\-id\fR=\fIKEY_ID\fR

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.

.TP 2m
\fB\-\-private\-key\-file\fR=\fIPATH_TO_FILE\fR

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.

.TP 2m
\fB\-\-team\-id\fR=\fITEAM_ID\fR

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.

.RE
.RE
.sp
.TP 2m

Options for the creation of a site key for web.



.RS 2m
.TP 2m
\fB\-\-web\fR

Creates a Key configured for websites.

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

.TP 2m
\fB\-\-allow\-amp\-traffic\fR

Whether this key can be used on AMP (Accelerated Mobile Pages) websites.

.TP 2m
\fB\-\-security\-preference\fR=\fISECURITY_PREFERENCE\fR

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.

\fISECURITY_PREFERENCE\fR must be one of: \fBbalance\fR,
\fBchallenge\-security\-preference\-unspecified\fR, \fBsecurity\fR,
\fBusability\fR.

.TP 2m

Configure if you want to use the POLICY_BASED_CHALLENGE option.



.RS 2m
.TP 2m
\fB\-\-action\-score\-thresholds\fR=[\fIACTION_SCORE_THRESHOLDS\fR,...]

The action to score threshold used for POLICY_BASED_CHALLENGE. For example:
\-\-action\-score\-thresholds=login='{"scoreThreshold":
"0.3"}',signup='{"scoreThreshold": "0.1"}' or
\-\-action\-score\-thresholds=file_path.(json|yaml).

.RS 2m
.TP 2m
\fBKEY\fR
Sets \f5KEY\fR value.

.TP 2m
\fBVALUE\fR
Sets \f5VALUE\fR value.

.RS 2m
.TP 2m
\fBscoreThreshold\fR
Sets \f5scoreThreshold\fR value.

.RE
.RE
.sp
\fBShorthand Example:\fR


.RS 2m
\-\-action\-score\-thresholds=string={scoreThreshold=float}
.RE


\fBJSON Example:\fR


.RS 2m
\-\-action\-score\-thresholds='{"string": {"scoreThreshold": float}}'
.RE


\fBFile Example:\fR


.RS 2m
\-\-action\-score\-thresholds=path_to_file.(yaml|json)
.RE


.TP 2m
\fB\-\-default\-score\-threshold\fR=\fIDEFAULT_SCORE_THRESHOLD\fR

The global threshold to be used for POLICY_BASED_CHALLENGE if no action specific
one exists.

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-allow\-all\-domains\fR

If set, domain name enforcement will NOT be enabled on this key.

.TP 2m
\fB\-\-domains\fR=[\fIDOMAINS\fR,...]

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'


.RE
.RE
.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "API REFERENCE"

This command uses the \fBrecaptchaenterprise/v1\fR API. The full documentation
for this API can be found at: https://cloud.google.com/recaptcha\-enterprise/



.SH "NOTES"

This variant is also available:

.RS 2m
$ gcloud alpha recaptcha keys update
.RE