reCAPTCHAEnterprise

import { reCAPTCHAEnterprise } from "https://googleapis.deno.dev/v1/recaptchaenterprise:v1.ts";

Help protect your website from fraudulent activity, spam, and abuse without creating friction.

class reCAPTCHAEnterprise {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsAssessmentsAnnotate(name: string, req: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest): Promise<GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse>;

async projectsAssessmentsCreate(parent: string, req: GoogleCloudRecaptchaenterpriseV1Assessment): Promise<GoogleCloudRecaptchaenterpriseV1Assessment>;

async projectsFirewallpoliciesCreate(parent: string, req: GoogleCloudRecaptchaenterpriseV1FirewallPolicy): Promise<GoogleCloudRecaptchaenterpriseV1FirewallPolicy>;

async projectsFirewallpoliciesDelete(name: string): Promise<GoogleProtobufEmpty>;

async projectsFirewallpoliciesGet(name: string): Promise<GoogleCloudRecaptchaenterpriseV1FirewallPolicy>;

async projectsFirewallpoliciesList(parent: string, opts?: ProjectsFirewallpoliciesListOptions): Promise<GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse>;

async projectsFirewallpoliciesPatch(

name: string,

req: GoogleCloudRecaptchaenterpriseV1FirewallPolicy,

opts?: ProjectsFirewallpoliciesPatchOptions,

): Promise<GoogleCloudRecaptchaenterpriseV1FirewallPolicy>;

async projectsFirewallpoliciesReorder(parent: string, req: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest): Promise<GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse>;

async projectsKeysCreate(parent: string, req: GoogleCloudRecaptchaenterpriseV1Key): Promise<GoogleCloudRecaptchaenterpriseV1Key>;

async projectsKeysDelete(name: string): Promise<GoogleProtobufEmpty>;

async projectsKeysGet(name: string): Promise<GoogleCloudRecaptchaenterpriseV1Key>;

async projectsKeysGetMetrics(name: string): Promise<GoogleCloudRecaptchaenterpriseV1Metrics>;

async projectsKeysList(parent: string, opts?: ProjectsKeysListOptions): Promise<GoogleCloudRecaptchaenterpriseV1ListKeysResponse>;

async projectsKeysMigrate(name: string, req: GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest): Promise<GoogleCloudRecaptchaenterpriseV1Key>;

async projectsKeysPatch(

name: string,

req: GoogleCloudRecaptchaenterpriseV1Key,

opts?: ProjectsKeysPatchOptions,

): Promise<GoogleCloudRecaptchaenterpriseV1Key>;

async projectsKeysRetrieveLegacySecretKey(key: string): Promise<GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse>;

async projectsRelatedaccountgroupmembershipsSearch(project: string, req: GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest): Promise<GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse>;

async projectsRelatedaccountgroupsList(parent: string, opts?: ProjectsRelatedaccountgroupsListOptions): Promise<GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse>;

async projectsRelatedaccountgroupsMembershipsList(parent: string, opts?: ProjectsRelatedaccountgroupsMembershipsListOptions): Promise<GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse>;

}

§Constructors

new reCAPTCHAEnterprise(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsAssessmentsAnnotate(name: string, req: GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentRequest): Promise<GoogleCloudRecaptchaenterpriseV1AnnotateAssessmentResponse>

[src]

Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.

@param name

Required. The resource name of the Assessment, in the format projects/{project}/assessments/{assessment}.

projectsAssessmentsCreate(parent: string, req: GoogleCloudRecaptchaenterpriseV1Assessment): Promise<GoogleCloudRecaptchaenterpriseV1Assessment>

[src]

Creates an Assessment of the likelihood an event is legitimate.

@param parent

Required. The name of the project in which the assessment will be created, in the format projects/{project}.

projectsFirewallpoliciesCreate(parent: string, req: GoogleCloudRecaptchaenterpriseV1FirewallPolicy): Promise<GoogleCloudRecaptchaenterpriseV1FirewallPolicy>

[src]

Creates a new FirewallPolicy, specifying conditions at which reCAPTCHA Enterprise actions can be executed. A project may have a maximum of 1000 policies.

@param parent

Required. The name of the project this policy will apply to, in the format projects/{project}.

projectsFirewallpoliciesDelete(name: string): Promise<GoogleProtobufEmpty>

[src]

Deletes the specified firewall policy.

@param name

Required. The name of the policy to be deleted, in the format projects/{project}/firewallpolicies/{firewallpolicy}.

projectsFirewallpoliciesGet(name: string): Promise<GoogleCloudRecaptchaenterpriseV1FirewallPolicy>

[src]

Returns the specified firewall policy.

@param name

Required. The name of the requested policy, in the format projects/{project}/firewallpolicies/{firewallpolicy}.

projectsFirewallpoliciesList(parent: string, opts?: ProjectsFirewallpoliciesListOptions): Promise<GoogleCloudRecaptchaenterpriseV1ListFirewallPoliciesResponse>

[src]

Returns the list of all firewall policies that belong to a project.

@param parent

Required. The name of the project to list the policies for, in the format projects/{project}.

projectsFirewallpoliciesPatch(name: string, req: GoogleCloudRecaptchaenterpriseV1FirewallPolicy, opts?: ProjectsFirewallpoliciesPatchOptions): Promise<GoogleCloudRecaptchaenterpriseV1FirewallPolicy>

[src]

Updates the specified firewall policy.

@param name

Identifier. The resource name for the FirewallPolicy in the format projects/{project}/firewallpolicies/{firewallpolicy}.

projectsFirewallpoliciesReorder(parent: string, req: GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesRequest): Promise<GoogleCloudRecaptchaenterpriseV1ReorderFirewallPoliciesResponse>

[src]

Reorders all firewall policies.

@param parent

Required. The name of the project to list the policies for, in the format projects/{project}.

projectsKeysCreate(parent: string, req: GoogleCloudRecaptchaenterpriseV1Key): Promise<GoogleCloudRecaptchaenterpriseV1Key>

[src]

Creates a new reCAPTCHA Enterprise key.

@param parent

Required. The name of the project in which the key will be created, in the format projects/{project}.

projectsKeysDelete(name: string): Promise<GoogleProtobufEmpty>

[src]

Deletes the specified key.

@param name

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

projectsKeysGet(name: string): Promise<GoogleCloudRecaptchaenterpriseV1Key>

[src]

Returns the specified key.

@param name

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

projectsKeysGetMetrics(name: string): Promise<GoogleCloudRecaptchaenterpriseV1Metrics>

[src]

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

@param name

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

projectsKeysList(parent: string, opts?: ProjectsKeysListOptions): Promise<GoogleCloudRecaptchaenterpriseV1ListKeysResponse>

[src]

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

@param parent

Required. The name of the project that contains the keys that will be listed, in the format projects/{project}.

projectsKeysMigrate(name: string, req: GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest): Promise<GoogleCloudRecaptchaenterpriseV1Key>

[src]

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.

@param name

Required. The name of the key to be migrated, in the format projects/{project}/keys/{key}.

projectsKeysPatch(name: string, req: GoogleCloudRecaptchaenterpriseV1Key, opts?: ProjectsKeysPatchOptions): Promise<GoogleCloudRecaptchaenterpriseV1Key>

[src]

Updates the specified key.

@param name

Identifier. The resource name for the Key in the format projects/{project}/keys/{key}.

projectsKeysRetrieveLegacySecretKey(key: string): Promise<GoogleCloudRecaptchaenterpriseV1RetrieveLegacySecretKeyResponse>

[src]

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.

@param key

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

projectsRelatedaccountgroupmembershipsSearch(project: string, req: GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsRequest): Promise<GoogleCloudRecaptchaenterpriseV1SearchRelatedAccountGroupMembershipsResponse>

[src]

Search group memberships related to a given account.

@param project

Required. The name of the project to search related account group memberships from. Specify the project name in the following format: projects/{project}.

projectsRelatedaccountgroupsList(parent: string, opts?: ProjectsRelatedaccountgroupsListOptions): Promise<GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupsResponse>

[src]

List groups of related accounts.

@param parent

Required. The name of the project to list related account groups from, in the format projects/{project}.

projectsRelatedaccountgroupsMembershipsList(parent: string, opts?: ProjectsRelatedaccountgroupsMembershipsListOptions): Promise<GoogleCloudRecaptchaenterpriseV1ListRelatedAccountGroupMembershipsResponse>

[src]

Get memberships in a group of related accounts.

@param parent

Required. The resource name for the related account group in the format projects/{project}/relatedaccountgroups/{relatedaccountgroup}.