Skip to main content
POST
/
events
/
auth
Log authentication event
curl --request POST \
  --url http://sandbox.mintlify.com/events/auth \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "<string>",
  "eventType": "login_success",
  "timestamp": "2023-11-07T05:31:56Z",
  "ipAddress": "<string>",
  "userAgent": "<string>",
  "location": {
    "country": "<string>",
    "city": "<string>"
  }
}
'
{
  "eventId": "<string>",
  "status": "success",
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Authentication event details

​
userId
string
required

Unique identifier for the user

​
eventType
enum<string>
required

Type of authentication event

Available options:
login_success,
login_failure,
logout,
password_change,
mfa_enabled,
mfa_disabled
​
timestamp
string<date-time>
required

Time when the auth event occurred

​
ipAddress
string
required

IP address where the auth event originated

​
userAgent
string

User agent string from the client

​
location
object

Geographic location details

Response

201 - application/json

Auth event logged successfully

​
eventId
string
required

Unique identifier for the logged event

​
status
enum<string>
required

Status of the event logging

Available options:
success,
failed
​
timestamp
string<date-time>

Time when the event was logged