Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. recaptchaenterprise
  5. recaptchaenterprise/v1
  6. getKey

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.recaptchaenterprise/v1.getKey

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Returns the specified key.

    Using getKey

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getKey(args: GetKeyArgs, opts?: InvokeOptions): Promise<GetKeyResult>
function getKeyOutput(args: GetKeyOutputArgs, opts?: InvokeOptions): Output<GetKeyResult>
    def get_key(key_id: Optional[str] = None,
            project: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetKeyResult
def get_key_output(key_id: Optional[pulumi.Input[str]] = None,
            project: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetKeyResult]
    func LookupKey(ctx *Context, args *LookupKeyArgs, opts ...InvokeOption) (*LookupKeyResult, error)
func LookupKeyOutput(ctx *Context, args *LookupKeyOutputArgs, opts ...InvokeOption) LookupKeyResultOutput

    > Note: This function is named LookupKey in the Go SDK.

    public static class GetKey 
{
    public static Task<GetKeyResult> InvokeAsync(GetKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetKeyResult> Invoke(GetKeyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetKeyResult> getKey(GetKeyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:recaptchaenterprise/v1:getKey
  arguments:
    # arguments dictionary

    The following arguments are supported:

    KeyId string
    Project string
    KeyId string
    Project string
    keyId String
    project String
    keyId string
    project string
    keyId String
    project String

    getKey Result

    The following output properties are available:

    AndroidSettings Pulumi.GoogleNative.reCAPTCHAEnterprise.V1.Outputs.GoogleCloudRecaptchaenterpriseV1AndroidKeySettingsResponse
    Settings for keys that can be used by Android apps.
    CreateTime string
    The timestamp corresponding to the creation of this key.
    DisplayName string
    Human-readable display name of this key. Modifiable by user.
    IosSettings Pulumi.GoogleNative.reCAPTCHAEnterprise.V1.Outputs.GoogleCloudRecaptchaenterpriseV1IOSKeySettingsResponse
    Settings for keys that can be used by iOS apps.
    Labels Dictionary<string, string>
    Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels).
    Name string
    Identifier. The resource name for the Key in the format projects/{project}/keys/{key}.
    TestingOptions Pulumi.GoogleNative.reCAPTCHAEnterprise.V1.Outputs.GoogleCloudRecaptchaenterpriseV1TestingOptionsResponse
    Optional. Options for user acceptance testing.
    WafSettings Pulumi.GoogleNative.reCAPTCHAEnterprise.V1.Outputs.GoogleCloudRecaptchaenterpriseV1WafSettingsResponse
    Optional. Settings for WAF
    WebSettings Pulumi.GoogleNative.reCAPTCHAEnterprise.V1.Outputs.GoogleCloudRecaptchaenterpriseV1WebKeySettingsResponse
    Settings for keys that can be used by websites.
    AndroidSettings GoogleCloudRecaptchaenterpriseV1AndroidKeySettingsResponse
    Settings for keys that can be used by Android apps.
    CreateTime string
    The timestamp corresponding to the creation of this key.
    DisplayName string
    Human-readable display name of this key. Modifiable by user.
    IosSettings GoogleCloudRecaptchaenterpriseV1IOSKeySettingsResponse
    Settings for keys that can be used by iOS apps.
    Labels map[string]string
    Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels).
    Name string
    Identifier. The resource name for the Key in the format projects/{project}/keys/{key}.
    TestingOptions GoogleCloudRecaptchaenterpriseV1TestingOptionsResponse
    Optional. Options for user acceptance testing.
    WafSettings GoogleCloudRecaptchaenterpriseV1WafSettingsResponse
    Optional. Settings for WAF
    WebSettings GoogleCloudRecaptchaenterpriseV1WebKeySettingsResponse
    Settings for keys that can be used by websites.
    androidSettings GoogleCloudRecaptchaenterpriseV1AndroidKeySettingsResponse
    Settings for keys that can be used by Android apps.
    createTime String
    The timestamp corresponding to the creation of this key.
    displayName String
    Human-readable display name of this key. Modifiable by user.
    iosSettings GoogleCloudRecaptchaenterpriseV1IOSKeySettingsResponse
    Settings for keys that can be used by iOS apps.
    labels Map<String,String>
    Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels).
    name String
    Identifier. The resource name for the Key in the format projects/{project}/keys/{key}.
    testingOptions GoogleCloudRecaptchaenterpriseV1TestingOptionsResponse
    Optional. Options for user acceptance testing.
    wafSettings GoogleCloudRecaptchaenterpriseV1WafSettingsResponse
    Optional. Settings for WAF
    webSettings GoogleCloudRecaptchaenterpriseV1WebKeySettingsResponse
    Settings for keys that can be used by websites.
    androidSettings GoogleCloudRecaptchaenterpriseV1AndroidKeySettingsResponse
    Settings for keys that can be used by Android apps.
    createTime string
    The timestamp corresponding to the creation of this key.
    displayName string
    Human-readable display name of this key. Modifiable by user.
    iosSettings GoogleCloudRecaptchaenterpriseV1IOSKeySettingsResponse
    Settings for keys that can be used by iOS apps.
    labels {[key: string]: string}
    Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels).
    name string
    Identifier. The resource name for the Key in the format projects/{project}/keys/{key}.
    testingOptions GoogleCloudRecaptchaenterpriseV1TestingOptionsResponse
    Optional. Options for user acceptance testing.
    wafSettings GoogleCloudRecaptchaenterpriseV1WafSettingsResponse
    Optional. Settings for WAF
    webSettings GoogleCloudRecaptchaenterpriseV1WebKeySettingsResponse
    Settings for keys that can be used by websites.
    android_settings GoogleCloudRecaptchaenterpriseV1AndroidKeySettingsResponse
    Settings for keys that can be used by Android apps.
    create_time str
    The timestamp corresponding to the creation of this key.
    display_name str
    Human-readable display name of this key. Modifiable by user.
    ios_settings GoogleCloudRecaptchaenterpriseV1IOSKeySettingsResponse
    Settings for keys that can be used by iOS apps.
    labels Mapping[str, str]
    Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels).
    name str
    Identifier. The resource name for the Key in the format projects/{project}/keys/{key}.
    testing_options GoogleCloudRecaptchaenterpriseV1TestingOptionsResponse
    Optional. Options for user acceptance testing.
    waf_settings GoogleCloudRecaptchaenterpriseV1WafSettingsResponse
    Optional. Settings for WAF
    web_settings GoogleCloudRecaptchaenterpriseV1WebKeySettingsResponse
    Settings for keys that can be used by websites.
    androidSettings Property Map
    Settings for keys that can be used by Android apps.
    createTime String
    The timestamp corresponding to the creation of this key.
    displayName String
    Human-readable display name of this key. Modifiable by user.
    iosSettings Property Map
    Settings for keys that can be used by iOS apps.
    labels Map<String>
    Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels).
    name String
    Identifier. The resource name for the Key in the format projects/{project}/keys/{key}.
    testingOptions Property Map
    Optional. Options for user acceptance testing.
    wafSettings Property Map
    Optional. Settings for WAF
    webSettings Property Map
    Settings for keys that can be used by websites.

    Supporting Types

    GoogleCloudRecaptchaenterpriseV1AndroidKeySettingsResponse

    AllowAllPackageNames bool
    Optional. If set to true, allowed_package_names are not enforced.
    AllowedPackageNames List<string>
    Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
    SupportNonGoogleAppStoreDistribution bool
    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.
    AllowAllPackageNames bool
    Optional. If set to true, allowed_package_names are not enforced.
    AllowedPackageNames []string
    Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
    SupportNonGoogleAppStoreDistribution bool
    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.
    allowAllPackageNames Boolean
    Optional. If set to true, allowed_package_names are not enforced.
    allowedPackageNames List<String>
    Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
    supportNonGoogleAppStoreDistribution Boolean
    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.
    allowAllPackageNames boolean
    Optional. If set to true, allowed_package_names are not enforced.
    allowedPackageNames string[]
    Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
    supportNonGoogleAppStoreDistribution boolean
    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.
    allow_all_package_names bool
    Optional. If set to true, allowed_package_names are not enforced.
    allowed_package_names Sequence[str]
    Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
    support_non_google_app_store_distribution bool
    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.
    allowAllPackageNames Boolean
    Optional. If set to true, allowed_package_names are not enforced.
    allowedPackageNames List<String>
    Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
    supportNonGoogleAppStoreDistribution Boolean
    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.

    GoogleCloudRecaptchaenterpriseV1AppleDeveloperIdResponse

    KeyId string
    The Apple developer key ID (10-character string).
    PrivateKey string
    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.
    TeamId string
    The Apple team ID (10-character string) owning the provisioning profile used to build your application.
    KeyId string
    The Apple developer key ID (10-character string).
    PrivateKey string
    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.
    TeamId string
    The Apple team ID (10-character string) owning the provisioning profile used to build your application.
    keyId String
    The Apple developer key ID (10-character string).
    privateKey String
    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.
    teamId String
    The Apple team ID (10-character string) owning the provisioning profile used to build your application.
    keyId string
    The Apple developer key ID (10-character string).
    privateKey string
    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.
    teamId string
    The Apple team ID (10-character string) owning the provisioning profile used to build your application.
    key_id str
    The Apple developer key ID (10-character string).
    private_key str
    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 str
    The Apple team ID (10-character string) owning the provisioning profile used to build your application.
    keyId String
    The Apple developer key ID (10-character string).
    privateKey String
    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.
    teamId String
    The Apple team ID (10-character string) owning the provisioning profile used to build your application.

    GoogleCloudRecaptchaenterpriseV1IOSKeySettingsResponse

    AllowAllBundleIds bool
    Optional. If set to true, allowed_bundle_ids are not enforced.
    AllowedBundleIds List<string>
    Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
    AppleDeveloperId Pulumi.GoogleNative.reCAPTCHAEnterprise.V1.Inputs.GoogleCloudRecaptchaenterpriseV1AppleDeveloperIdResponse
    Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA Enterprise to get a better assessment of the integrity of your app.
    AllowAllBundleIds bool
    Optional. If set to true, allowed_bundle_ids are not enforced.
    AllowedBundleIds []string
    Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
    AppleDeveloperId GoogleCloudRecaptchaenterpriseV1AppleDeveloperIdResponse
    Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA Enterprise to get a better assessment of the integrity of your app.
    allowAllBundleIds Boolean
    Optional. If set to true, allowed_bundle_ids are not enforced.
    allowedBundleIds List<String>
    Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
    appleDeveloperId GoogleCloudRecaptchaenterpriseV1AppleDeveloperIdResponse
    Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA Enterprise to get a better assessment of the integrity of your app.
    allowAllBundleIds boolean
    Optional. If set to true, allowed_bundle_ids are not enforced.
    allowedBundleIds string[]
    Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
    appleDeveloperId GoogleCloudRecaptchaenterpriseV1AppleDeveloperIdResponse
    Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA Enterprise to get a better assessment of the integrity of your app.
    allow_all_bundle_ids bool
    Optional. If set to true, allowed_bundle_ids are not enforced.
    allowed_bundle_ids Sequence[str]
    Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
    apple_developer_id GoogleCloudRecaptchaenterpriseV1AppleDeveloperIdResponse
    Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA Enterprise to get a better assessment of the integrity of your app.
    allowAllBundleIds Boolean
    Optional. If set to true, allowed_bundle_ids are not enforced.
    allowedBundleIds List<String>
    Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
    appleDeveloperId Property Map
    Optional. Apple Developer account details for the app that is protected by the reCAPTCHA Key. reCAPTCHA Enterprise leverages platform-specific checks like Apple App Attest and Apple DeviceCheck to protect your app from abuse. Providing these fields allows reCAPTCHA Enterprise to get a better assessment of the integrity of your app.

    GoogleCloudRecaptchaenterpriseV1TestingOptionsResponse

    TestingChallenge string
    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.
    TestingScore double
    Optional. All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
    TestingChallenge string
    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.
    TestingScore float64
    Optional. All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
    testingChallenge String
    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.
    testingScore Double
    Optional. All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
    testingChallenge string
    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.
    testingScore number
    Optional. All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
    testing_challenge str
    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 float
    Optional. All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
    testingChallenge String
    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.
    testingScore Number
    Optional. All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.

    GoogleCloudRecaptchaenterpriseV1WafSettingsResponse

    WafFeature string
    The WAF feature for which this key is enabled.
    WafService string
    The WAF service that uses this key.
    WafFeature string
    The WAF feature for which this key is enabled.
    WafService string
    The WAF service that uses this key.
    wafFeature String
    The WAF feature for which this key is enabled.
    wafService String
    The WAF service that uses this key.
    wafFeature string
    The WAF feature for which this key is enabled.
    wafService string
    The WAF service that uses this key.
    waf_feature str
    The WAF feature for which this key is enabled.
    waf_service str
    The WAF service that uses this key.
    wafFeature String
    The WAF feature for which this key is enabled.
    wafService String
    The WAF service that uses this key.

    GoogleCloudRecaptchaenterpriseV1WebKeySettingsResponse

    AllowAllDomains bool
    Optional. If set to true, it means allowed_domains will not be enforced.
    AllowAmpTraffic bool
    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.
    AllowedDomains List<string>
    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'
    ChallengeSecurityPreference string
    Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
    IntegrationType string
    Describes how this key is integrated with the website.
    AllowAllDomains bool
    Optional. If set to true, it means allowed_domains will not be enforced.
    AllowAmpTraffic bool
    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.
    AllowedDomains []string
    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'
    ChallengeSecurityPreference string
    Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
    IntegrationType string
    Describes how this key is integrated with the website.
    allowAllDomains Boolean
    Optional. If set to true, it means allowed_domains will not be enforced.
    allowAmpTraffic Boolean
    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.
    allowedDomains List<String>
    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'
    challengeSecurityPreference String
    Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
    integrationType String
    Describes how this key is integrated with the website.
    allowAllDomains boolean
    Optional. If set to true, it means allowed_domains will not be enforced.
    allowAmpTraffic boolean
    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.
    allowedDomains string[]
    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'
    challengeSecurityPreference string
    Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
    integrationType string
    Describes how this key is integrated with the website.
    allow_all_domains bool
    Optional. If set to true, it means allowed_domains will not be enforced.
    allow_amp_traffic bool
    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 Sequence[str]
    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'
    challenge_security_preference str
    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 str
    Describes how this key is integrated with the website.
    allowAllDomains Boolean
    Optional. If set to true, it means allowed_domains will not be enforced.
    allowAmpTraffic Boolean
    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.
    allowedDomains List<String>
    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'
    challengeSecurityPreference String
    Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE.
    integrationType String
    Describes how this key is integrated with the website.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native