gcloud-help/gcloud/alpha/recaptcha/keys/create

NAME
    gcloud alpha recaptcha keys create - create a Key

SYNOPSIS
    gcloud alpha recaptcha keys create --display-name=DISPLAY_NAME
        ([--android (--allow-all-package-names
          | --package-names=[PACKAGE_NAMES,...])
          : --support-non-google-app-store-distribution]
          | [--ios (--allow-all-bundle-ids | --bundle-ids=[BUNDLE_IDS,...])
          : --key-id=KEY_ID
          --private-key-file=PRIVATE_KEY_FILE --team-id=TEAM_ID]
          | [--web (--allow-all-domains | --domains=[DOMAINS,...])
          : --allow-amp-traffic --integration-type=INTEGRATION_TYPE
          --security-preference=SECURITY_PREFERENCE
          --testing-challenge=TESTING_CHALLENGE]) [--labels=[KEY=VALUE,...]]
        [--testing-score=TESTING_SCORE]
        [--waf-feature=WAF_FEATURE : --waf-service=WAF_SERVICE]
        [GCLOUD_WIDE_FLAG ...]

DESCRIPTION
    (ALPHA) Create a reCAPTCHA Key.

EXAMPLES
    To create a new reCAPTCHA key for websites showing no CAPTCHA challenge,
    run:

        $ gcloud alpha recaptcha keys create --display-name=test-key-name \
            --web --allow-all-domains --integration-type=score

REQUIRED FLAGS
     --display-name=DISPLAY_NAME
        A human-readable name for the key. Typically a site or app name.

     Exactly one of these must be specified:

       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.

         --support-non-google-app-store-distribution
            If set, this key can be used in an Android application that is
            available for download in app stores other than the Google Play
            Store.

            This setting allows your key to accept traffic from devices without
            Google Mobile Services (GMS) installed.

         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.

         Exactly one of these must 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=PRIVATE_KEY_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.

              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.

         --integration-type=INTEGRATION_TYPE
            Configures how reCAPTCHA will operate on your site. This only
            applies to 'web' platform. INTEGRATION_TYPE must be one of:

             checkbox
                Renders the classic "I'm not a robot" checkbox, and a captcha
                challenge for low scoring events

             invisible
                Does not display the "I'm not a robot" checkbox, but may show
                CAPTCHA challenges after risk analysis

             score
                Shows no CAPTCHA challenge on the page

         --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.

         --testing-challenge=TESTING_CHALLENGE
            For CHECKBOX and INVISIBLE Keys only, this option configures
            whether challenges will be issued for execute requests.
            TESTING_CHALLENGE must be one of:

             challenge
                Execute requests for this key will always return an unsolvable
                challenge consisting of a message about this testing key.

             nocaptcha
                Execute requests for this key will always return nocaptcha.

         Exactly one of these must 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'

OPTIONAL FLAGS
     --labels=[KEY=VALUE,...]
        List of label KEY=VALUE pairs to add.

        Keys must start with a lowercase character and contain only hyphens
        (-), underscores (_), lowercase characters, and numbers. Values must
        contain only hyphens (-), underscores (_), lowercase characters, and
        numbers.

     --testing-score=TESTING_SCORE
        If set, all assessments for this key will return this score. Must be
        between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.

     Options for the creation of a WAF-enabled key. For more information,
     please refer to
     https://cloud.google.com/recaptcha-enterprise/docs/integration-overview.

       --waf-feature=WAF_FEATURE
          The WAF feature to use. For more information, see
          https://cloud.google.com/recaptcha-enterprise/docs/usecase#comparison_of_features.
          WAF_FEATURE must be one of:

           action-token
              Use reCAPTCHA action-tokens to protect user actions.

           challenge-page
              Redirects suspicious traffic to reCAPTCHA challenge page.

           express
              Assesses requests without tokens or frontend integration.

           session-token
              Use reCAPTCHA session-tokens to protect the whole user session on
              the site's domain.

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

       --waf-service=WAF_SERVICE
          The WAF service provider to use. WAF_SERVICE must be one of:

           ca
              Cloud Armor

           cloudflare
              Cloudflare

           fastly
              Fastly

           unspecified
              No specified WAF service

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 create