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
google-native.recaptchaenterprise/v1.getKey
Explore with Pulumi AI
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
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)
public static Output<GetKeyResult> getKey(GetKeyArgs args, InvokeOptions options)
fn::invoke:
  function: google-native:recaptchaenterprise/v1:getKey
  arguments:
    # arguments dictionaryThe following arguments are supported:
getKey Result
The following output properties are available:
- AndroidSettings Pulumi.Google Native.re CAPTCHAEnterprise. V1. Outputs. Google Cloud Recaptchaenterprise V1Android Key Settings Response 
- 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.Google Native.re CAPTCHAEnterprise. V1. Outputs. Google Cloud Recaptchaenterprise V1IOSKey Settings Response 
- 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.Google Native.re CAPTCHAEnterprise. V1. Outputs. Google Cloud Recaptchaenterprise V1Testing Options Response 
- Optional. Options for user acceptance testing.
- WafSettings Pulumi.Google Native.re CAPTCHAEnterprise. V1. Outputs. Google Cloud Recaptchaenterprise V1Waf Settings Response 
- Optional. Settings for WAF
- WebSettings Pulumi.Google Native.re CAPTCHAEnterprise. V1. Outputs. Google Cloud Recaptchaenterprise V1Web Key Settings Response 
- Settings for keys that can be used by websites.
- AndroidSettings GoogleCloud Recaptchaenterprise V1Android Key Settings Response 
- 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 GoogleCloud Recaptchaenterprise V1IOSKey Settings Response 
- 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 GoogleCloud Recaptchaenterprise V1Testing Options Response 
- Optional. Options for user acceptance testing.
- WafSettings GoogleCloud Recaptchaenterprise V1Waf Settings Response 
- Optional. Settings for WAF
- WebSettings GoogleCloud Recaptchaenterprise V1Web Key Settings Response 
- Settings for keys that can be used by websites.
- androidSettings GoogleCloud Recaptchaenterprise V1Android Key Settings Response 
- 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 GoogleCloud Recaptchaenterprise V1IOSKey Settings Response 
- 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 GoogleCloud Recaptchaenterprise V1Testing Options Response 
- Optional. Options for user acceptance testing.
- wafSettings GoogleCloud Recaptchaenterprise V1Waf Settings Response 
- Optional. Settings for WAF
- webSettings GoogleCloud Recaptchaenterprise V1Web Key Settings Response 
- Settings for keys that can be used by websites.
- androidSettings GoogleCloud Recaptchaenterprise V1Android Key Settings Response 
- 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 GoogleCloud Recaptchaenterprise V1IOSKey Settings Response 
- 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 GoogleCloud Recaptchaenterprise V1Testing Options Response 
- Optional. Options for user acceptance testing.
- wafSettings GoogleCloud Recaptchaenterprise V1Waf Settings Response 
- Optional. Settings for WAF
- webSettings GoogleCloud Recaptchaenterprise V1Web Key Settings Response 
- Settings for keys that can be used by websites.
- android_settings GoogleCloud Recaptchaenterprise V1Android Key Settings Response 
- 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 GoogleCloud Recaptchaenterprise V1IOSKey Settings Response 
- 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 GoogleCloud Recaptchaenterprise V1Testing Options Response 
- Optional. Options for user acceptance testing.
- waf_settings GoogleCloud Recaptchaenterprise V1Waf Settings Response 
- Optional. Settings for WAF
- web_settings GoogleCloud Recaptchaenterprise V1Web Key Settings Response 
- 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      
- AllowAll boolPackage Names 
- Optional. If set to true, allowed_package_names are not enforced.
- AllowedPackage List<string>Names 
- Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
- SupportNon boolGoogle App Store Distribution 
- 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.
- AllowAll boolPackage Names 
- Optional. If set to true, allowed_package_names are not enforced.
- AllowedPackage []stringNames 
- Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
- SupportNon boolGoogle App Store Distribution 
- 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.
- allowAll BooleanPackage Names 
- Optional. If set to true, allowed_package_names are not enforced.
- allowedPackage List<String>Names 
- Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
- supportNon BooleanGoogle App Store Distribution 
- 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.
- allowAll booleanPackage Names 
- Optional. If set to true, allowed_package_names are not enforced.
- allowedPackage string[]Names 
- Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
- supportNon booleanGoogle App Store Distribution 
- 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_ boolpackage_ names 
- Optional. If set to true, allowed_package_names are not enforced.
- allowed_package_ Sequence[str]names 
- Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
- support_non_ boolgoogle_ app_ store_ distribution 
- 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.
- allowAll BooleanPackage Names 
- Optional. If set to true, allowed_package_names are not enforced.
- allowedPackage List<String>Names 
- Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
- supportNon BooleanGoogle App Store Distribution 
- 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     
- AllowAll boolBundle Ids 
- Optional. If set to true, allowed_bundle_ids are not enforced.
- AllowedBundle List<string>Ids 
- Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
- AppleDeveloper Pulumi.Id Google Native.re CAPTCHAEnterprise. V1. Inputs. Google Cloud Recaptchaenterprise V1Apple Developer Id Response 
- 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.
- AllowAll boolBundle Ids 
- Optional. If set to true, allowed_bundle_ids are not enforced.
- AllowedBundle []stringIds 
- Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
- AppleDeveloper GoogleId Cloud Recaptchaenterprise V1Apple Developer Id Response 
- 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.
- allowAll BooleanBundle Ids 
- Optional. If set to true, allowed_bundle_ids are not enforced.
- allowedBundle List<String>Ids 
- Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
- appleDeveloper GoogleId Cloud Recaptchaenterprise V1Apple Developer Id Response 
- 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.
- allowAll booleanBundle Ids 
- Optional. If set to true, allowed_bundle_ids are not enforced.
- allowedBundle string[]Ids 
- Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
- appleDeveloper GoogleId Cloud Recaptchaenterprise V1Apple Developer Id Response 
- 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_ boolbundle_ ids 
- Optional. If set to true, allowed_bundle_ids are not enforced.
- allowed_bundle_ Sequence[str]ids 
- Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
- apple_developer_ Googleid Cloud Recaptchaenterprise V1Apple Developer Id Response 
- 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.
- allowAll BooleanBundle Ids 
- Optional. If set to true, allowed_bundle_ids are not enforced.
- allowedBundle List<String>Ids 
- Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
- appleDeveloper Property MapId 
- 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      
- AllowAll boolDomains 
- Optional. If set to true, it means allowed_domains will not be enforced.
- AllowAmp boolTraffic 
- 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'
- ChallengeSecurity stringPreference 
- 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.
- AllowAll boolDomains 
- Optional. If set to true, it means allowed_domains will not be enforced.
- AllowAmp boolTraffic 
- 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'
- ChallengeSecurity stringPreference 
- 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.
- allowAll BooleanDomains 
- Optional. If set to true, it means allowed_domains will not be enforced.
- allowAmp BooleanTraffic 
- 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'
- challengeSecurity StringPreference 
- 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.
- allowAll booleanDomains 
- Optional. If set to true, it means allowed_domains will not be enforced.
- allowAmp booleanTraffic 
- 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'
- challengeSecurity stringPreference 
- 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_ booldomains 
- Optional. If set to true, it means allowed_domains will not be enforced.
- allow_amp_ booltraffic 
- 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_ strpreference 
- 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.
- allowAll BooleanDomains 
- Optional. If set to true, it means allowed_domains will not be enforced.
- allowAmp BooleanTraffic 
- 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'
- challengeSecurity StringPreference 
- 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 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