json icon

Customer Authenticated

v1.0.0events

Published when a customer has successfully authenticated.

1{
2  "$schema": "http://json-schema.org/draft-07/schema#",
3  "title": "CustomerAuthenticated",
4  "description": "Emitted when a customer successfully authenticates",
5  "type": "object",
6  "properties": {
7    "eventId": {
8      "description": "Unique identifier for this event",
9      "type": "string",
10      "format": "uuid"
11    },
12    "occurredAt": {
13      "description": "Time the customer authenticated",
14      "type": "string",
15      "format": "date-time"
16    },
17    "customerId": {
18      "description": "Unique identifier of the customer that authenticated",
19      "type": "string",
20      "format": "uuid"
21    },
22    "method": {
23      "description": "How the customer authenticated",
24      "type": "string",
25      "enum": ["PASSWORD", "SSO", "MFA"]
26    },
27    "ipAddress": {
28      "description": "IP address the sign-in came from",
29      "type": "string"
30    }
31  },
32  "required": ["eventId", "occurredAt", "customerId", "method"]
33}
34

Details

Format
JSON Schema
Resource
events
Filename
schema.json

Versions