Interface EventTrackingV2

interface EventTrackingV2 {
    trackUserLoginFailure(login, exists, metadata?): void;
    trackUserLoginFailure(login, metadata?): void;
    trackUserLoginSuccess(login, user?, metadata?): void;
    trackUserLoginSuccess(login, userId, metadata?): void;
}

Index

Methods

trackUserLoginFailure trackUserLoginSuccess

Methods

trackUserLoginFailure

trackUserLoginFailure(login, exists, metadata?): void
Links a failed login event to the current trace.
Parameters
- login: string
  The login key (username, email...) used by the user to authenticate.
- exists: boolean
  If the user exists.
- Optional metadata: any
  Custom fields to link to the login failure event.
Returns void
- Defined in index.d.ts:895
trackUserLoginFailure(login, metadata?): void
Links a failed login event to the current trace.
Parameters
- login: string
  The login key (username, email...) used by the user to authenticate.
- Optional metadata: any
  Custom fields to link to the login failure event.
Returns void
- Defined in index.d.ts:902

trackUserLoginSuccess

trackUserLoginSuccess(login, user?, metadata?): void
Links a successful login event to the current trace. Will link the passed user to the current trace with Appsec.setUser() internally.
Parameters
- login: string
  The login key (username, email...) used by the user to authenticate.
- Optional user: null | User
  Properties of the authenticated user. Accepts custom fields. Can be null.
- Optional metadata: any
  Custom fields to link to the login success event.
Returns void
- Defined in index.d.ts:879
trackUserLoginSuccess(login, userId, metadata?): void
Links a successful login event to the current trace. Will link the passed user to the current trace with Appsec.setUser() internally.
Parameters
- login: string
  The login key (username, email...) used by the user to authenticate.
- userId: string
  Identifier of the authenticated user.
- Optional metadata: any
  Custom fields to link to the login success event.
Returns void
- Defined in index.d.ts:887