Login

Example Use Case

Monitoring for potential fraudulent logins to an Entity's account.

Request Specifications

Required API Field	Definition	Notes
`timestamp`	Timestamp of the event.
One of: `external_entity_id` `entity_token`	Unique identifier for the Entity associated with the login.
`username`	The username associated with the login.
`login_method`	The type of login event.	Possible enum values: password, sso, passwordless

Example Request/Response:

{
    "event_type": "login",
    "event_status": "attempted",
    "event_lifecycle_id": "MJ-CO-427kjfs",
    "data": {
        "timestamp": "2024-03-25T23:50:34.681Z",
        "external_login_id": "MJ-CO-427kjfs",
        "external_entity_id": "9e82d5e7-ada0-4957-a8fd-4d937c99bae8",
        "username": "John.Doe84",
        "status": "attempted",
        "login_method": "password",
        "sso": null,
        "device": {
            "ip_address_v4": "88.232.60.238",
            "device_type": "mobile"
        },
        "meta": {
            "foo": "bar"
        },
        "supplemental_data": {}
    }
}

{
    "status_code": 201,
    "event_request_token": "EV-vlm5H2TqSi8GyFT7ZaHB",
    "_links": {
        "self": {
            "href": "/v1/events/EV-vlm5H2TqSi8GyFT7ZaHB"
        }
    },
    "event": {
        "event_type": "login",
        "event_status": "PROCESSED",
        "data": {
            "timestamp": "2024-03-25T23:50:38.666Z",
            "external_entity_id": "9e82d5e7-ada0-4957-a8fd-4d937c99bae8",
            "username": "John.Doe84",
            "status": "attempted",
            "login_method": "password",
            "sso": null,
            "device": {
                "ip_address_v4": "88.232.60.238",
                "device_type": "mobile"
            },
            "meta": {
                "foo": "bar"
            },
            "supplemental_data": {},
            "entity_token": "P-TfkFe6lCPkElc9Xktd3V",
            "external_login_id": null
        },
        "evaluations": [],
        "journey_applications": []
    }
}