Updates the specified key.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: recaptchaenterprise1 --scope <scope> projects keys-patch ...

Required Scalar Argument

  • <name> (string)
    • Identifier. The resource name for the Key in the format projects/{project}/keys/{key}.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

GoogleCloudRecaptchaenterpriseV1Key:
  android-settings:
    allow-all-package-names: boolean
    allowed-package-names: [string]
    support-non-google-app-store-distribution: boolean
  create-time: string
  display-name: string
  ios-settings:
    allow-all-bundle-ids: boolean
    allowed-bundle-ids: [string]
    apple-developer-id:
      key-id: string
      private-key: string
      team-id: string
  labels: { string: string }
  name: string
  testing-options:
    testing-challenge: string
    testing-score: number
  waf-settings:
    waf-feature: string
    waf-service: string
  web-settings:
    allow-all-domains: boolean
    allow-amp-traffic: boolean
    allowed-domains: [string]
    challenge-security-preference: string
    integration-type: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r .android-settings allow-all-package-names=false
    • Optional. If set to true, allowed_package_names are not enforced.
  • allowed-package-names=erat
    • Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
    • Each invocation of this argument appends the given value to the array.

  • support-non-google-app-store-distribution=false

    • Optional. Set to true for keys that are used in an Android application that is available for download in app stores in addition to the Google Play Store.

  • .. create-time=amet

    • Output only. The timestamp corresponding to the creation of this key.
  • display-name=est
    • Required. Human-readable display name of this key. Modifiable by user.
  • ios-settings allow-all-bundle-ids=false
    • Optional. If set to true, allowed_bundle_ids are not enforced.
  • allowed-bundle-ids=consetetur
    • Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
    • Each invocation of this argument appends the given value to the array.
  • apple-developer-id key-id=stet
    • Required. The Apple developer key ID (10-character string).
  • private-key=est
    • Required. Input only. A private key (downloaded as a text file with a .p8 file extension) generated for your Apple Developer account. Ensure that Apple DeviceCheck is enabled for the private key.

  • team-id=aliquyam

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

  • ... labels=key=elitr

    • Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels).
    • the value will be associated with the given key
  • name=duo
    • Identifier. The resource name for the Key in the format projects/{project}/keys/{key}.
  • testing-options testing-challenge=diam
    • Optional. For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if CHALLENGE.

  • testing-score=0.3473002864453434

    • Optional. All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.

  • ..waf-settings waf-feature=sed

    • Required. The WAF feature for which this key is enabled.

  • waf-service=eos

    • Required. The WAF service that uses this key.

  • ..web-settings allow-all-domains=true

    • Optional. If set to true, it means allowed_domains will not be enforced.
  • allow-amp-traffic=true
    • Optional. If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.
  • allowed-domains=sea
    • Optional. 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: 'example.com' or 'subdomain.example.com'
    • Each invocation of this argument appends the given value to the array.
  • challenge-security-preference=et
    • Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
  • integration-type=at
    • Required. Describes how this key is integrated with the website.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p update-mask=string
    • Optional. The mask to control which fields of the key get updated. If the mask is not present, all fields will be updated.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").