assessments

Creates, updates, deletes, gets or lists an assessments resource.

Overview

Name	assessments
Type	Resource
Id	google.recaptchaenterprise.assessments

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	projectsId		Creates an Assessment of the likelihood an event is legitimate.
annotate	exec	projectsId, assessmentsId		Annotates a previously created Assessment to provide additional information on whether the event turned out to be authentic or fraudulent.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
assessmentsId	string
projectsId	string

INSERT examples

create

Creates an Assessment of the likelihood an event is legitimate.

INSERT INTO google.recaptchaenterprise.assessments (
data__accountVerification,
data__assessmentEnvironment,
data__event,
data__privatePasswordLeakVerification,
projectsId
)
SELECT 
'{{ accountVerification }}',
'{{ assessmentEnvironment }}',
'{{ event }}',
'{{ privatePasswordLeakVerification }}',
'{{ projectsId }}'
RETURNING
name,
accountDefenderAssessment,
accountVerification,
assessmentEnvironment,
event,
firewallPolicyAssessment,
fraudPreventionAssessment,
fraudSignals,
phoneFraudAssessment,
policyEvaluation,
privatePasswordLeakVerification,
riskAnalysis,
tokenProperties
;

Manifest

# Description fields are for documentation purposes
- name: assessments
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the assessments resource.
  - name: accountVerification
    description: |
      Optional. Account verification information for identity verification. The assessment event must include a token and site key to use this feature.
    value:
      endpoints:
        - emailAddress: "{{ emailAddress }}"
          lastVerificationTime: "{{ lastVerificationTime }}"
          phoneNumber: "{{ phoneNumber }}"
          requestToken: "{{ requestToken }}"
      languageCode: "{{ languageCode }}"
      latestVerificationResult: "{{ latestVerificationResult }}"
      username: "{{ username }}"
  - name: assessmentEnvironment
    description: |
      Optional. The environment creating the assessment. This describes your environment (the system invoking CreateAssessment), NOT the environment of your user.
    value:
      client: "{{ client }}"
      version: "{{ version }}"
  - name: event
    description: |
      Optional. The event being assessed.
    value:
      expectedAction: "{{ expectedAction }}"
      express: {{ express }}
      firewallPolicyEvaluation: {{ firewallPolicyEvaluation }}
      fraudPrevention: "{{ fraudPrevention }}"
      hashedAccountId: "{{ hashedAccountId }}"
      headers:
        - "{{ headers }}"
      ja3: "{{ ja3 }}"
      ja4: "{{ ja4 }}"
      requestedUri: "{{ requestedUri }}"
      siteKey: "{{ siteKey }}"
      token: "{{ token }}"
      transactionData:
        billingAddress:
          address:
            - "{{ address }}"
          administrativeArea: "{{ administrativeArea }}"
          locality: "{{ locality }}"
          postalCode: "{{ postalCode }}"
          recipient: "{{ recipient }}"
          regionCode: "{{ regionCode }}"
        cardBin: "{{ cardBin }}"
        cardLastFour: "{{ cardLastFour }}"
        currencyCode: "{{ currencyCode }}"
        gatewayInfo:
          avsResponseCode: "{{ avsResponseCode }}"
          cvvResponseCode: "{{ cvvResponseCode }}"
          gatewayResponseCode: "{{ gatewayResponseCode }}"
          name: "{{ name }}"
        items:
          - merchantAccountId: "{{ merchantAccountId }}"
            name: "{{ name }}"
            quantity: "{{ quantity }}"
            value: {{ value }}
        merchants:
          - accountId: "{{ accountId }}"
            creationMs: "{{ creationMs }}"
            email: "{{ email }}"
            emailVerified: {{ emailVerified }}
            phoneNumber: "{{ phoneNumber }}"
            phoneVerified: {{ phoneVerified }}
        paymentMethod: "{{ paymentMethod }}"
        shippingAddress:
          address:
            - "{{ address }}"
          administrativeArea: "{{ administrativeArea }}"
          locality: "{{ locality }}"
          postalCode: "{{ postalCode }}"
          recipient: "{{ recipient }}"
          regionCode: "{{ regionCode }}"
        shippingValue: {{ shippingValue }}
        transactionId: "{{ transactionId }}"
        user:
          accountId: "{{ accountId }}"
          creationMs: "{{ creationMs }}"
          email: "{{ email }}"
          emailVerified: {{ emailVerified }}
          phoneNumber: "{{ phoneNumber }}"
          phoneVerified: {{ phoneVerified }}
        value: {{ value }}
      userAgent: "{{ userAgent }}"
      userInfo:
        accountId: "{{ accountId }}"
        createAccountTime: "{{ createAccountTime }}"
        userIds:
          - email: "{{ email }}"
            phoneNumber: "{{ phoneNumber }}"
            username: "{{ username }}"
      userIpAddress: "{{ userIpAddress }}"
      wafTokenAssessment: {{ wafTokenAssessment }}
  - name: privatePasswordLeakVerification
    description: |
      Optional. The private password leak verification field contains the parameters that are used to to check for leaks privately without sharing user credentials.
    value:
      encryptedLeakMatchPrefixes:
        - "{{ encryptedLeakMatchPrefixes }}"
      encryptedUserCredentialsHash: "{{ encryptedUserCredentialsHash }}"
      lookupHashPrefix: "{{ lookupHashPrefix }}"
      reencryptedUserCredentialsHash: "{{ reencryptedUserCredentialsHash }}"

Lifecycle Methods

annotate

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

EXEC google.recaptchaenterprise.assessments.annotate 
@projectsId='{{ projectsId }}' --required, 
@assessmentsId='{{ assessmentsId }}' --required 
@@json=
'{
"accountId": "{{ accountId }}", 
"annotation": "{{ annotation }}", 
"hashedAccountId": "{{ hashedAccountId }}", 
"phoneAuthenticationEvent": "{{ phoneAuthenticationEvent }}", 
"reasons": "{{ reasons }}", 
"transactionEvent": "{{ transactionEvent }}"
}'
;