Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Zero Trust Risk Scoring API

The Zero Trust Risk Scoring API from APIs.io Engineering Platform — 4 operation(s) for zero trust risk scoring.

This API exposes 5 operations across 4 paths, and defines 16 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

5 operations 4 paths 16 schemas 3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Zero Trust Risk Scoring API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Zero Trust Risk Scoring 5
GET
/accounts/{account_id}/zt_risk_scoring/{user_id}
APIs.io Engineering Platform Get risk event/score information for a specific user
dlp-risk-score-summary-get-for-user 2 params → 4XX200
POST
/accounts/{account_id}/zt_risk_scoring/{user_id}/reset
APIs.io Engineering Platform Clear the risk score for a particular user
dlp-risk-score-reset-post 2 params → 4XX200
GET
/accounts/{account_id}/zt_risk_scoring/behaviors
APIs.io Engineering Platform Get all behaviors and associated configuration
dlp-risk-score-behaviors-get 1 param → 4XX200
PUT
/accounts/{account_id}/zt_risk_scoring/behaviors
APIs.io Engineering Platform Update configuration for risk behaviors
dlp-risk-score-behaviors-put 1 param body → 4XX200
GET
/accounts/{account_id}/zt_risk_scoring/summary
APIs.io Engineering Platform Get risk score info for all users in the account
dlp-risk-score-summary-get 1 param → 4XX200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are dlp_UserRiskInfo (6 properties), dlp_RiskEvent (5 properties), dlp_RiskEvents (5 properties), dlp_result_info (4 properties). Each schema is shown below with its type and property counts.

dlp_RiskLevel
string
dlp_api-response-common
object
3 properties 3 required
dlp_api-response-collection
object
dlp_api-response-single
object
dlp_Behavior
object
4 properties 4 required
dlp_RiskSummary
object
1 property 1 required
dlp_api-response-common-failure
object
4 properties 4 required
dlp_Behaviors
object
1 property 1 required
dlp_messages
array
dlp_result_info
object
4 properties
dlp_RiskEvents
object
5 properties 3 required
dlp_UpdateBehavior
object
2 properties 2 required
dlp_UpdateBehaviors
object
1 property 1 required
dlp_RiskEvent
object
5 properties 4 required
dlp_UserRiskInfo
object
6 properties 6 required
dlp_Empty
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-zero-trust-risk-scoring-api-openapi.yml Raw ↑