Package google.cloud.webrisk.v1eap1

Index

WebRiskServiceV1EAP1

Web Risk v1eap1 API defines an interface to detect malicious URIs on your website and in client applications.

EvaluateUri

rpc EvaluateUri(EvaluateUriRequest) returns (EvaluateUriResponse)

This method is used to evaluate how malicious a URI is according to given threat types. Multiple threat types may be searched in a single query. The response will list a confidence level for all requested threat types (currently only for the SOCIAL_ENGINEERING threat type) representing how much the URI is predicted to be malicious.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

EvaluateUriRequest

Request to evaluate risk of URI according to the given threat types.

Fields
uri

string

Required. The URI to be evaluated.

threat_types[]

ThreatType

Required. The threat types to evaluate against.

allow_scan

bool

Whether the caller would like to allow this method to scan the provided URI.

EvaluateUriResponse

Response type for requests to evaluate URIs.

Fields
scores[]

Score

Evaluation scores per threat type given.

Score

Score of a URI, represented as a ConfidenceLevel for every threat type given.

Fields
threat_type

ThreatType

Threat type associated with this score.

confidence_level

ConfidenceLevel

Confidence level according to the given threat type.

ConfidenceLevel

Confidence level in how risky a URI is predicted to be.

Enums
CONFIDENCE_LEVEL_UNSPECIFIED Default type that indicates this enum hasn't been specified. This is not a valid ConfidenceLevel, another type must be specified instead.
SAFE URIs that are considered as safe.
LOW Low confidence that the URI given is risky for this threat type.
MEDIUM Medium confidence that the URI given is risky for this threat type.
HIGH High confidence that the URI given is risky for this threat type.
VERY_HIGH Very high confidence that the URI given is risky for this threat type.
EXTREMELY_HIGH Extremely high confidence that the URI given is risky for this threat type.

ThreatType

The type of threat.

Enums
THREAT_TYPE_UNSPECIFIED Default type that indicates this enum hasn't been specified. This is not a valid ThreatType, one of the other types must be specified instead.
SOCIAL_ENGINEERING Social engineering targeting any platform.