Class AccessPlatformClient

Private client

Private otpProviders

Private password

Private Optional session

Private sessionStore

Private username

Private isAuthenticated

• get isAuthenticated(): boolean

• Returns boolean

Private attemptChallenge

• attemptChallenge(flowId, deviceId, clientId, accessToken, authContextId, availableChallenges): Promise<string>

• Parameters

  • flowId: string

  • deviceId: string

  • clientId: string

  • accessToken: string

  • authContextId: string

  • availableChallenges: TAuthChallenge[]

  Returns Promise<string>

Private createIntermediateAccessToken

• createIntermediateAccessToken(deviceId, clientId, clientSecret, authCode?): Promise<string>

• Parameters

  • deviceId: string

  • clientId: string

  • clientSecret: string

  • Optional authCode: string

  Returns Promise<string>

Private createSession

• createSession(): Promise<TSession>

• Returns Promise<TSession>

Private createSessionFromAuthorizationCode

• createSessionFromAuthorizationCode(deviceId, clientId, clientSecret, authorizationCode): TSession

• Parameters

  • deviceId: string

  • clientId: string

  • clientSecret: string

  • authorizationCode: TOAuthAuthorizationCodeResponse

  Returns TSession

Private evaluateAuth

• evaluateAuth(flowId, deviceId, clientId, accessToken, captchaToken?): Promise<TEvaluateAuthResponse>

• Parameters

  • flowId: string

  • deviceId: string

  • clientId: string

  • accessToken: string

  • Optional captchaToken: string

  Returns Promise<TEvaluateAuthResponse>

Private getOTPCode

• getOTPCode(type): Promise<string>

• Parameters

  • type: EOTPType

  Returns Promise<string>

Private hydrateSession

• hydrateSession(): undefined | {
      accessToken: string;
      clientId: string;
      clientSecret: string;
      deviceId: string;
      refreshToken: string;
      refreshTokenExpiresAt: number;
  }

• Returns undefined | {
      accessToken: string;
      clientId: string;
      clientSecret: string;
      deviceId: string;
      refreshToken: string;
      refreshTokenExpiresAt: number;
  }

Private refreshOrCreateSession

• refreshOrCreateSession(): Promise<TSession>

• Returns Promise<TSession>

Private refreshSession

• refreshSession(): Promise<TSession>

• Returns Promise<TSession>

Private requestOTPToken

• requestOTPToken(flowId, deviceId, accessToken, authContextId, type): Promise<void>

• Parameters

  • flowId: string

  • deviceId: string

  • accessToken: string

  • authContextId: string

  • type: EAuthChallengeType

  Returns Promise<void>

Private revokeSession

• revokeSession(): Promise<void>

• Returns Promise<void>

Private submitChallenge

• submitChallenge(flowId, deviceId, clientId, accessToken, authContextId, type, value): Promise<TVerifySignInResponse>

• Parameters

  • flowId: string

  • deviceId: string

  • clientId: string

  • accessToken: string

  • authContextId: string

  • type: EAuthChallengeType

  • value: string

  Returns Promise<TVerifySignInResponse>

Private submitOTPChallenge

• submitOTPChallenge(flowId, deviceId, clientId, accessToken, authContextId, type): Promise<string>

• Parameters

  • flowId: string

  • deviceId: string

  • clientId: string

  • accessToken: string

  • authContextId: string

  • type: TOTP | SMS_OTP | EMAIL_OTP

  Returns Promise<string>

Private submitPasswordChallenge

• submitPasswordChallenge(flowId, deviceId, clientId, accessToken, authContextId): Promise<string>

• Parameters

  • flowId: string

  • deviceId: string

  • clientId: string

  • accessToken: string

  • authContextId: string

  Returns Promise<string>