Method: projects.assessments.annotate

• HTTP request
• Path parameters
• Request body
  • JSON representation
• Response body
• Authorization Scopes
• IAM Permissions
• Annotation

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

HTTP request

POST https://recaptchaenterprise.googleapis.com/v1/{name=projects/*/assessments/*}:annotate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name	string Required. The resource name of the Assessment, in the format "projects/{project}/assessments/{assessment}". Authorization requires the following IAM permission on the specified resource name: recaptchaenterprise.assessments.annotate

Request body

The request body contains data with the following structure:

JSON representation
{ "annotation": enum (Annotation) }

Fields
annotation	enum (Annotation) Required. The annotation that will be assigned to the Event.

Response body

If successful, the response body will be empty.

Authorization Scopes

Requires the following OAuth scope:

• https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following Cloud IAM permission on the name resource:

• recaptchaenterprise.assessments.annotate

For more information, see the Cloud IAM Documentation.

Annotation

Enum that reprensents the types of annotations.

Enums
ANNOTATION_UNSPECIFIED	Default unspecified type.
LEGITIMATE	Provides information that the event turned out to be legitimate.
FRAUDULENT	Provides information that the event turned out to be fraudulent.
PASSWORD_CORRECT	Provides information that the event was related to a login event in which the user typed the correct password.
PASSWORD_INCORRECT	Provides information that the event was related to a login event in which the user typed the incorrect password.