Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.recaptchaenterprise/v1.getKey
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
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:
getKey Result
The following output properties are available:
- Android
Settings Pulumi.Google Native.re CAPTCHAEnterprise. V1. Outputs. Google Cloud Recaptchaenterprise V1Android Key Settings Response Settings for keys that can be used by Android apps.
- Create
Time string The timestamp corresponding to the creation of this key.
- Display
Name string Human-readable display name of this key. Modifiable by user.
- Ios
Settings 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}
.- Testing
Options Pulumi.Google Native.re CAPTCHAEnterprise. V1. Outputs. Google Cloud Recaptchaenterprise V1Testing Options Response Optional. Options for user acceptance testing.
- Waf
Settings Pulumi.Google Native.re CAPTCHAEnterprise. V1. Outputs. Google Cloud Recaptchaenterprise V1Waf Settings Response Optional. Settings for WAF
- Web
Settings Pulumi.Google Native.re CAPTCHAEnterprise. V1. Outputs. Google Cloud 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 string The timestamp corresponding to the creation of this key.
- Display
Name string 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 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}
.- 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.
- android
Settings GoogleCloud Recaptchaenterprise V1Android Key Settings Response Settings for keys that can be used by Android apps.
- create
Time String The timestamp corresponding to the creation of this key.
- display
Name String 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 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}
.- 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.
- android
Settings GoogleCloud Recaptchaenterprise V1Android Key Settings Response Settings for keys that can be used by Android apps.
- create
Time string The timestamp corresponding to the creation of this key.
- display
Name string 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 {[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}
.- 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.
- 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.
- android
Settings Property Map Settings for keys that can be used by Android apps.
- create
Time String The timestamp corresponding to the creation of this key.
- display
Name String Human-readable display name of this key. Modifiable by user.
- ios
Settings 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}
.- testing
Options Property Map Optional. Options for user acceptance testing.
- waf
Settings Property Map Optional. Settings for WAF
- web
Settings Property Map Settings for keys that can be used by websites.
Supporting Types
GoogleCloudRecaptchaenterpriseV1AndroidKeySettingsResponse
- Allow
All boolPackage Names Optional. If set to true, allowed_package_names are not enforced.
- Allowed
Package List<string>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.
- Allow
All boolPackage Names Optional. If set to true, allowed_package_names are not enforced.
- Allowed
Package []stringNames 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.
- allow
All BooleanPackage Names Optional. If set to true, allowed_package_names are not enforced.
- allowed
Package List<String>Names Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
- support
Non 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 booleanPackage Names Optional. If set to true, allowed_package_names are not enforced.
- allowed
Package string[]Names Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
- support
Non 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.
- allow
All BooleanPackage Names Optional. If set to true, allowed_package_names are not enforced.
- allowed
Package List<String>Names Optional. Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
- support
Non 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
- Key
Id string The Apple developer key ID (10-character string).
- Private
Key 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.
- Team
Id string The Apple team ID (10-character string) owning the provisioning profile used to build your application.
- Key
Id string The Apple developer key ID (10-character string).
- Private
Key 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.
- Team
Id string The Apple team ID (10-character string) owning the provisioning profile used to build your application.
- key
Id String The Apple developer key ID (10-character string).
- private
Key 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.
- team
Id String The Apple team ID (10-character string) owning the provisioning profile used to build your application.
- key
Id string The Apple developer key ID (10-character string).
- private
Key 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.
- team
Id 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.
- key
Id String The Apple developer key ID (10-character string).
- private
Key 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.
- team
Id String The Apple team ID (10-character string) owning the provisioning profile used to build your application.
GoogleCloudRecaptchaenterpriseV1IOSKeySettingsResponse
- Allow
All boolBundle Ids Optional. If set to true, allowed_bundle_ids are not enforced.
- Allowed
Bundle List<string>Ids Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
- Apple
Developer 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.
- Allow
All boolBundle Ids Optional. If set to true, allowed_bundle_ids are not enforced.
- Allowed
Bundle []stringIds 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.
- allow
All BooleanBundle Ids Optional. If set to true, allowed_bundle_ids are not enforced.
- allowed
Bundle List<String>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.
- allow
All booleanBundle Ids Optional. If set to true, allowed_bundle_ids are not enforced.
- allowed
Bundle string[]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.
- 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.
- allow
All BooleanBundle Ids Optional. If set to true, allowed_bundle_ids are not enforced.
- allowed
Bundle List<String>Ids Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
- apple
Developer 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
- Testing
Challenge 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.
- Testing
Score double Optional. All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
- Testing
Challenge 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.
- Testing
Score float64 Optional. All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
- testing
Challenge 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.
- testing
Score Double Optional. All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
- testing
Challenge 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.
- testing
Score 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.
- testing
Challenge 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.
- testing
Score Number Optional. All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
GoogleCloudRecaptchaenterpriseV1WafSettingsResponse
- Waf
Feature string The WAF feature for which this key is enabled.
- Waf
Service string The WAF service that uses this key.
- Waf
Feature string The WAF feature for which this key is enabled.
- Waf
Service string The WAF service that uses this key.
- waf
Feature String The WAF feature for which this key is enabled.
- waf
Service String The WAF service that uses this key.
- waf
Feature string The WAF feature for which this key is enabled.
- waf
Service 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.
- waf
Feature String The WAF feature for which this key is enabled.
- waf
Service String The WAF service that uses this key.
GoogleCloudRecaptchaenterpriseV1WebKeySettingsResponse
- 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 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'
- Challenge
Security 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.
- Integration
Type 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 []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'
- Challenge
Security 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.
- Integration
Type string Describes how this key is integrated with the website.
- allow
All BooleanDomains Optional. If set to true, it means allowed_domains will not be enforced.
- allow
Amp 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.
- allowed
Domains 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'
- challenge
Security 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.
- integration
Type String Describes how this key is integrated with the website.
- allow
All booleanDomains Optional. If set to true, it means allowed_domains will not be enforced.
- allow
Amp 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.
- allowed
Domains 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'
- challenge
Security 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.
- integration
Type 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.
- allow
All BooleanDomains Optional. If set to true, it means allowed_domains will not be enforced.
- allow
Amp 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.
- allowed
Domains 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'
- challenge
Security 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.
- integration
Type 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.