keys

Creates, updates, deletes, gets or lists a keys resource.

Overview

Name	keys
Type	Resource
Id	google.recaptchaenterprise.keys

Fields

Name	Datatype	Description
name	string	Identifier. The resource name for the Key in the format projects/{project}/keys/{key}.
androidSettings	object	Settings specific to keys that can be used by Android apps.
createTime	string	Output only. The timestamp corresponding to the creation of this key.
displayName	string	Required. Human-readable display name of this key. Modifiable by user.
expressSettings	object	Settings specific to keys that can be used for reCAPTCHA Express.
iosSettings	object	Settings specific to keys that can be used by iOS apps.
labels	object	Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).
testingOptions	object	Options for user acceptance testing.
wafSettings	object	Settings specific to keys that can be used for WAF (Web Application Firewall).
webSettings	object	Settings specific to keys that can be used by websites.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	keysId, projectsId	Returns the specified key.
list	SELECT	projectsId	Returns the list of all keys that belong to a project.
create	INSERT	projectsId	Creates a new reCAPTCHA Enterprise key.
delete	DELETE	keysId, projectsId	Deletes the specified key.
patch	UPDATE	keysId, projectsId	Updates the specified key.
migrate	EXEC	keysId, projectsId	Migrates an existing key from reCAPTCHA to reCAPTCHA Enterprise. Once a key is migrated, it can be used from either product. SiteVerify requests are billed as CreateAssessment calls. You must be authenticated as one of the current owners of the reCAPTCHA Key, and your user must have the reCAPTCHA Enterprise Admin IAM role in the destination project.

SELECT examples

Returns the list of all keys that belong to a project.

SELECT
name,
androidSettings,
createTime,
displayName,
expressSettings,
iosSettings,
labels,
testingOptions,
wafSettings,
webSettings
FROM google.recaptchaenterprise.keys
WHERE projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new keys resource.

All Properties

/*+ create */
INSERT INTO google.recaptchaenterprise.keys (
projectsId,
wafSettings,
name,
iosSettings,
testingOptions,
webSettings,
androidSettings,
labels,
displayName,
expressSettings
)
SELECT 
'{{ projectsId }}',
'{{ wafSettings }}',
'{{ name }}',
'{{ iosSettings }}',
'{{ testingOptions }}',
'{{ webSettings }}',
'{{ androidSettings }}',
'{{ labels }}',
'{{ displayName }}',
'{{ expressSettings }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: wafSettings
      value:
        - name: wafFeature
          value: string
        - name: wafService
          value: string
    - name: name
      value: string
    - name: iosSettings
      value:
        - name: appleDeveloperId
          value:
            - name: keyId
              value: string
            - name: teamId
              value: string
            - name: privateKey
              value: string
        - name: allowedBundleIds
          value:
            - string
        - name: allowAllBundleIds
          value: boolean
    - name: createTime
      value: string
    - name: testingOptions
      value:
        - name: testingChallenge
          value: string
        - name: testingScore
          value: number
    - name: webSettings
      value:
        - name: challengeSecurityPreference
          value: string
        - name: allowedDomains
          value:
            - string
        - name: allowAllDomains
          value: boolean
        - name: allowAmpTraffic
          value: boolean
        - name: integrationType
          value: string
    - name: androidSettings
      value:
        - name: supportNonGoogleAppStoreDistribution
          value: boolean
        - name: allowedPackageNames
          value:
            - string
        - name: allowAllPackageNames
          value: boolean
    - name: labels
      value: object
    - name: displayName
      value: string
    - name: expressSettings
      value: []

UPDATE example

Updates a keys resource.

/*+ update */
UPDATE google.recaptchaenterprise.keys
SET 
wafSettings = '{{ wafSettings }}',
name = '{{ name }}',
iosSettings = '{{ iosSettings }}',
testingOptions = '{{ testingOptions }}',
webSettings = '{{ webSettings }}',
androidSettings = '{{ androidSettings }}',
labels = '{{ labels }}',
displayName = '{{ displayName }}',
expressSettings = '{{ expressSettings }}'
WHERE 
keysId = '{{ keysId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified keys resource.

/*+ delete */
DELETE FROM google.recaptchaenterprise.keys
WHERE keysId = '{{ keysId }}'
AND projectsId = '{{ projectsId }}';