keys

Overview

Name	keys
Type	Resource
Id	google.recaptchaenterprise.keys

Fields

Name	Datatype	Description
name	string	The resource name for the Key in the format "projects/{project}/keys/{key}".
testingOptions	object	Options for user acceptance testing.
displayName	string	Human-readable display name of this key. Modifiable by user.
androidSettings	object	Settings specific to keys that can be used by Android apps.
iosSettings	object	Settings specific to keys that can be used by iOS apps.
labels	object	See Creating and managing labels.
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.
createTime	string	Output only. The timestamp corresponding to the creation of this key.

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.
_list	EXEC	projectsId	Returns the list of all keys that belong to a project.
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.
patch	EXEC	keysId, projectsId	Updates the specified key.