Skip to main content

LoginEvent

Audit Login Event

userIdNullableUserId (string)nullable
usernameUserName (string)nullable
brandIdBrandId (string)required
sessionIdNullableSessionId (string)nullable

Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

isSuccessfulIsSuccessful (boolean)required
failureReasonFailureReason (string)nullablerequired

Possible values: Value must match regular expression (INVALID_PASSWORD|MAXIMUM_CONCURRENT_SESSIONS_EXCEEDED|MAXIMUM_LOGIN_ATTEMPTS_EXCEEDED|BRAND_DISABLED|USER_DISABLED|BRAND_LOCKED|USER_LOCKED|INVALID_USERNAME|MFA_INVALID|MFA_EXPIRED|IP_RESTRICTED|BRAND_SELECT_TIMEOUT|DOMAIN_RESTRICTED|BRAND_RESTRICTED|INVALID_REDIRECT_URL|PASSWORD_TOO_COMMON|NEW_PASSWORD_CURRENTLY_USED|LOGIN_PROVIDER_DISABLED|CONNECTION_TEST_ERROR|SSO_REQUEST_TIMEOUT|FIRST_PARTY_APPLICATION_LOGIN_DISABLED|EMAIL_NOT_VERIFIED|OTHER|CAPTCHA_VERIFICATION_FAILED|INVALID_USERID)

isProxyLoginIsProxyLogin (boolean)required
proxyDetails objectnullablerequired
agentUserIdUserId (string)required
agentSessionIdSessionId (string)nullablerequired

Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

reasonReason (string)required
isUserApprovedIsUserApproved (boolean)required
productProduct (string)required
urlUrl (string)required
ipAddressIpAddress (string)required
location objectrequired
countryCodecountryCode (string)nullable

Possible values: Value must match regular expression [A-Z][A-Z]

regionregion (string)nullable
citycity (string)nullable
postalCodepostalCode (string)nullable
latitudenumber<double>nullable
longitudenumber<double>nullable
dmaCodedmaCode (integer)nullable
areaCodeareaCode (integer)nullable
metroCodemetroCode (integer)nullable
authentication objectnullablerequired
methodMethod (string)required

Possible values: Value must match regular expression (BASIC|SAML|OAUTH|CAS|LDAP|TOKEN|CERT|SUPPORT_TOKEN)

methodVersionMethodVersion (string)nullablerequired
secondFactorSecondFactor (string)nullablerequired
platform objectrequired
userAgentUserAgent (string)required
userAgentVersionUserAgentVersion (string)required
operatingSystemOperatingSystem (string)required
operatingSystemVersionOperatingSystemVersion (string)nullablerequired
deviceFamilyDeviceFamily (string)nullable
LoginEvent
{
  "userId": "string",
  "username": "string",
  "brandId": "string",
  "sessionId": "string",
  "isSuccessful": true,
  "failureReason": "string",
  "isProxyLogin": true,
  "proxyDetails": {
    "agentUserId": "string",
    "agentSessionId": "string",
    "reason": "string",
    "isUserApproved": true
  },
  "product": "string",
  "url": "string",
  "ipAddress": "string",
  "location": {
    "countryCode": "string",
    "region": "string",
    "city": "string",
    "postalCode": "string",
    "latitude": 0,
    "longitude": 0,
    "dmaCode": 0,
    "areaCode": 0,
    "metroCode": 0
  },
  "authentication": {
    "method": "string",
    "methodVersion": "string",
    "secondFactor": "string"
  },
  "platform": {
    "userAgent": "string",
    "userAgentVersion": "string",
    "operatingSystem": "string",
    "operatingSystemVersion": "string",
    "deviceFamily": "string"
  }
}