Class ProjectsResource.KeysResource

The "keys" collection of methods.

Inheritance

object

ProjectsResource.KeysResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.RecaptchaEnterprise.v1

Assembly: Google.Apis.RecaptchaEnterprise.v1.dll

Syntax

public class ProjectsResource.KeysResource

Constructors

KeysResource(IClientService)

Constructs a new resource.

Declaration

public KeysResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Methods

AddIpOverride(GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest, string)

Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 100. * For any conflict (such as IP already exists or IP part of an existing IP range), an error is returned.

Declaration

public virtual ProjectsResource.KeysResource.AddIpOverrideRequest AddIpOverride(GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest	body	The body of the request.
string	name	Required. The name of the key to which the IP override is added, in the format projects/{project}/keys/{key}.

Returns

Type	Description
ProjectsResource.KeysResource.AddIpOverrideRequest

Create(GoogleCloudRecaptchaenterpriseV1Key, string)

Creates a new reCAPTCHA Enterprise key.

Declaration

public virtual ProjectsResource.KeysResource.CreateRequest Create(GoogleCloudRecaptchaenterpriseV1Key body, string parent)

Parameters

Type	Name	Description
GoogleCloudRecaptchaenterpriseV1Key	body	The body of the request.
string	parent	Required. The name of the project in which the key is created, in the format projects/{project}.

Returns

Type	Description
ProjectsResource.KeysResource.CreateRequest

Delete(string)

Deletes the specified key.

Declaration

public virtual ProjectsResource.KeysResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the key to be deleted, in the format projects/{project}/keys/{key}.

Returns

Type	Description
ProjectsResource.KeysResource.DeleteRequest

Get(string)

Returns the specified key.

Declaration

public virtual ProjectsResource.KeysResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the requested key, in the format projects/{project}/keys/{key}.

Returns

Type	Description
ProjectsResource.KeysResource.GetRequest

GetMetrics(string)

Get some aggregated metrics for a Key. This data can be used to build dashboards.

Declaration

public virtual ProjectsResource.KeysResource.GetMetricsRequest GetMetrics(string name)

Parameters

Type	Name	Description
string	name	Required. The name of the requested metrics, in the format projects/{project}/keys/{key}/metrics.

Returns

Type	Description
ProjectsResource.KeysResource.GetMetricsRequest

List(string)

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

Declaration

public virtual ProjectsResource.KeysResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The name of the project that contains the keys that is listed, in the format projects/{project}.

Returns

Type	Description
ProjectsResource.KeysResource.ListRequest

ListIpOverrides(string)

Lists all IP overrides for a key.

Declaration

public virtual ProjectsResource.KeysResource.ListIpOverridesRequest ListIpOverrides(string parent)

Parameters

Type	Name	Description
string	parent	Required. The parent key for which the IP overrides are listed, in the format projects/{project}/keys/{key}.

Returns

Type	Description
ProjectsResource.KeysResource.ListIpOverridesRequest

Migrate(GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest, string)

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.

Declaration

public virtual ProjectsResource.KeysResource.MigrateRequest Migrate(GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest	body	The body of the request.
string	name	Required. The name of the key to be migrated, in the format projects/{project}/keys/{key}.

Returns

Type	Description
ProjectsResource.KeysResource.MigrateRequest

Patch(GoogleCloudRecaptchaenterpriseV1Key, string)

Updates the specified key.

Declaration

public virtual ProjectsResource.KeysResource.PatchRequest Patch(GoogleCloudRecaptchaenterpriseV1Key body, string name)

Parameters

Type	Name	Description
GoogleCloudRecaptchaenterpriseV1Key	body	The body of the request.
string	name	Identifier. The resource name for the Key in the format projects/{project}/keys/{key}.

Returns

Type	Description
ProjectsResource.KeysResource.PatchRequest

RemoveIpOverride(GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest, string)

Removes an IP override from a key. The following restrictions hold: * If the IP isn't found in an existing IP override, a NOT_FOUND error is returned. * If the IP is found in an existing IP override, but the override type does not match, a NOT_FOUND error is returned.

Declaration

public virtual ProjectsResource.KeysResource.RemoveIpOverrideRequest RemoveIpOverride(GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudRecaptchaenterpriseV1RemoveIpOverrideRequest	body	The body of the request.
string	name	Required. The name of the key from which the IP override is removed, in the format projects/{project}/keys/{key}.

Returns

Type	Description
ProjectsResource.KeysResource.RemoveIpOverrideRequest

RetrieveLegacySecretKey(string)

Returns the secret key related to the specified public key. You must use the legacy secret key only in a 3rd party integration with legacy reCAPTCHA.

Declaration

public virtual ProjectsResource.KeysResource.RetrieveLegacySecretKeyRequest RetrieveLegacySecretKey(string key)

Parameters

Type	Name	Description
string	key	Required. The public key name linked to the requested secret key in the format projects/{project}/keys/{key}.

Returns

Type	Description
ProjectsResource.KeysResource.RetrieveLegacySecretKeyRequest