Sign in

v1

latestOpenAPI 3.0.32026-08-064799140.5 KB
AuthEvents

Create a new authentication event for a user

post/users/{userID}/authEvents

Path parameters

userIDstring required
Example:usr-4693224802260150919

Unique identifier of the user. Format: usr-<number>.

Request body

usernamestring required
eventType'sign_up' | 'login' | 'new_passkey_added' required
method'password' | 'email_otp' | 'email_link' | 'phone_otp' | 'passkey' | 'social_github' | 'social_google' | 'social_microsoft' required
status'success' | 'failure' required

Example request

{
  "clientInformation": {
    "remoteAddress": "::ffff:172.18.0.1",
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36"
  }
}

Response

Auth event has been created.

authEventIDstring required
userIDstring required

ID of the user

usernamestring required
eventType'sign_up' | 'login' | 'new_passkey_added' required
method'password' | 'email_otp' | 'email_link' | 'phone_otp' | 'passkey' | 'social_github' | 'social_google' | 'social_microsoft' required
createdstring required

Timestamp of when the entity was created in yyyy-MM-dd'T'HH:mm:ss format

createdMsinteger required
status'success' | 'failure' required