Class LoginCredentials

This credentials class allow the user to use the SDK by providing username and password as authentication parameters.

Hierarchy

LoginCredentials

Implements

Credentials

Index

Constructors

Methods

getAuthToken initiateMfa logout redeemMfa

Constructors

constructor

new LoginCredentials(credentials: LoginCredentialsOptions): LoginCredentials
Constructor of the class
Parameters
- credentials: LoginCredentialsOptions
  
  including the login details
Returns LoginCredentials

Methods

getAuthToken

getAuthToken(): Promise<string>
Requests the authentication token, the first time a login request is done, after that if a valid refresh token is available we use it to get a new token.

Returns
valid token to make requests to the Platform API

Returns Promise<string>

Implementation of Credentials.getAuthToken

initiateMfa

initiateMfa(requestObject: MfaRequest): Promise<void>
Requests an MFA verification code the user can redeem as part of Platform MFA verification.
Parameters
- requestObject: MfaRequest
  
  Request Object | Include the required parameters in order to initiate MFA verification
Returns Promise<void>

logout

logout(): Promise<any>
Returns Promise<any>

Implementation of Credentials.logout

redeemMfa

redeemMfa(requestObject: RedeemMfaRequest): Promise<string>
Redeems an MFA verification code as part of Platform MFA verification to get new MFA verified token

Returns
valid token to make requests to the Platform API for MFA protected account resources
Parameters
- requestObject: RedeemMfaRequest
  
  Request Object | Include the required parameters in order to redeem an MFA token
Returns Promise<string>

Generated using TypeDoc