Overview

Version information

Version : 1.0.0

URI scheme

Host : localhost:6767
BasePath : /
Schemes : HTTP

Consumes

  • application/json

Produces

  • application/json

Paths

Accepts risk event

POST /event

Description

Accepts general risk events for various entities and event types.

Parameters

Type Name Description Schema

Body

body
required

Object which hold information about occured risk event.

body

body

Name Description Schema

date
optional

Example : "2017-09-25T13:02:45.635"

string

entityId
optional

Id of entity involved in risk action.

string

eventId
optional

Unique value of event. Event with same Id sent twice wouldn’t override preceeded one.

string

eventType
optional

One of following values: user, ip, session, application, device.
Example : "ip"

string

issuer
optional

Origin of event.

string

severityLevel
optional

Indicates how important action happened. Number between 0 and 10.
Example : 5

integer

Responses

HTTP Code Description Schema

204

Event accepted

No Content

400

Unsupported event

No Content

422

Cannot parse body

No Content

Finds risk level by event type and ID

GET /risk/{eventType}/{entityId}

Description

Returns risk level for particular event type and related entity.

Parameters

Type Name Description Schema

Path

entityId
required

Id of entity against which risk was calculated

string

Path

eventType
required

Type of risk event. Possible types are: user, ip, session, device, application.

string

Responses

HTTP Code Description Schema

200

Risk level for selected entity and event type

Response 200

400

Unsupported event type

No Content

Response 200

Name Schema

risk
optional

integer