5.3 Login with Password

The loginWithPassword function is the instance function that initialises your access to Bayun. The function takes the following parameters :

Let's say the user is logging-in using their login-id of [e-mail].

• sessionId : Unique sessionId.

  You can provide a unique sessionId to the loginWithPassword function call. If an empty sessionId i.e " " is provided, Bayun creates and returns a unique sessionId in the successful authentication response in successCallback.

  Same sessionId should be provided in all the subsequent calls to the Bayun APIs as an argument.

• companyName : Unique name of the company/tenant the authenticating employee belongs to, e.g. bayunsystems.com. This should be chosen using exactly the same methodology that was used during user registration via registerEmployeeWithPassword. Note that in some cases the email domain of the user could be different from the domain of the tenant this user belongs to. In such a case, the domain-name part of the tenant is what should be used as the companyName parameter.

• companyEmployeeId : EmployeeId unique within the company, e.g. [e-mail]. This should also be chosen using exactly the same methodology that was used during user registration via registerEmployeeWithPassword. Note that while just the "username" portion might suffice in some cases, it is preferable to use the full loginId for consistency.

• password : Password of the user. Used to keep user secret keys protected. Never stored or transmitted by BayunSDK in clear. If the developer wishes, it can be a cryptographic hash of the password instead of the cleartext password itself. Bayun just needs a unique secret known to the user only, or something unique generated from it, for keeping the user lockboxes protected in such a way that nobody other than the user has access to it (similar to how iPhone does it with user’s device PIN).

• autoCreateEmployee : Determines whether or not an employee should be created automatically on Bayun’s system if it does not already exist within the given company. If set to true, an attempt is made to authenticate against an existing employee account first, but if there is no such employee within the given company, a new one is created instead with the supplied credentials. This provides an easy integration option for the developer to use a single login call in an existing application for the simpler use-cases, rather than having to integrate separately with more involved registration & authorization flow along-with the separate login flow. Use this feature only when Bayun’s auth mechanism is being used as shadow auth for your app’s own authentication, using the same user password. And make sure the user has already been successfully authenticated to your own app’s authentication mechanism, before calling Bayun’s loginWithPassword function with autoCreateEmployee set to true.

• authorizeEmployeeCallback : Block to be executed if employee public key authorization is pending, returns employeePublicKey.

• securityQuestionsCallback : Most developers can just leave it null for default functionality. It is used for taking answers of Security Questions from the User when extra security with two-factor authorization is enabled. By default, the SDK uses AlertView to take User’s input for the answers of the Security Questions, if two-factor authorization is enabled for the user trying to authenticate. The developer can optionally provide a custom UI block for taking User’s input, to match with the look-and-feel of the app, instead of relying on the default alert-view. If non-null, this block will need to take user answers to the security questions as an input and call validateSecurityQuestions API method in the SDK. The callback is triggered when two-factor authorization is enabled for the user authenticating with Bayun. The Security Questions and QuestionIds are returned through data of the callback, in the form of an ArrayList of HashMap with key "securityQuestions".

• passphraseCallback : Optional block if passphrase is enabled. Most developers can just leave it null for default functionality. It is used for taking user passphrase input for extra security when passphrase is explicitly enabled by the user. By default, the SDK uses AlertView to take user input for passphrase if it is enabled for a user. However the developer can optionally provide a custom UI block to match with the look-and-feel of the app instead of relying on the default alert-view. If non-null, this block will need to take user passphrase as input and call Bayun validatePassphrase method for Passphrase validation.

• successCallback : Success block to be executed after successful employee login.

• failureCallback : Failure block to be executed if employee login fails, returns BayunError.

Validate Security Questions

Use validateSecurityQuestions function to validate the security questions' answers.

The function takes the following parameters :

• sessionId : Unique SessionId which is received in the login/registration function response.

• answers : Security questions' answers of type List.

• successCallback : Success block to be executed after successful Security Questions' Answers validation.

• failureCallback : Failure block to be executed if user Security Questions' Answers validation fails, returns BayunError.

Validate Passphrase

Use validatePassphrase function to validate the passphrase.

The function takes the following parameters :

• sessionId : Unique SessionId which is received in the login/registration function response.

• passphrase : Passphrase to validate.

• successCallback : Success block to be executed after successful user passphrase validation.

• failureCallback : Failure block to be executed if user passphrase validation fails, returns BayunError.

Sample Code

JavaScript

const sessionId = "<sessionId>";
const companyName = "bayunsystems.com"; // company portion from loginId
const companyEmployeeId = "username";   // username portion from loginId
const password = "<employeePassword>"; 
const autoCreateEmployee = true; //Boolean value


const securityQuestionsCallback = data => {
  if (data.sessionId) {
    if(data.authenticationResponse == BayunCore.AuthenticateResponse.VERIFY_SECURITY_QUESTIONS){
      let securityQuestionsArray = data.securityQuestions;
      // securityQuestionsArray is a list of Security Question Objects with questionId, questionText 
      // Iterate through securityQuestionsArray
      securityQuestionsArray.forEach(val=>{
        console.log(val.questionId);
        console.log(val.questionText);
      });
      //Show custom UI to take user input for the answers.
      //Call validateSecurityQuestions function with the user provided answers.
      
      //Here answers object is created just for reference
       var answers=[]; 
       answers.push({questionId: "<questionId1>", answer: "<answer1>"});
       answers.push({questionId: "<questionId2>", answer: "<answer2>"});
       answers.push({questionId: "<questionId3>", answer: "<answer3>"});
       answers.push({questionId: "<questionId4>", answer: "<answer4>"});
       answers.push({questionId: "<questionId5>", answer: "<answer5>"});
      
      const successCallback = data => {
        if (data.sessionId) {
          //Security Questions' Answers validated and LoggedIn Successfully
        }};
      
      const failureCallback = error => {
          console.error(error);
       };
       
       bayunCore.validateSecurityQuestions(data.sessionId, answers, null, successCallback, failureCallback);
    }
  }
};

const passphraseCallback = data => {
  if (data.sessionId) {
    if(data.authenticationResponse == BayunCore.AuthenticateResponse.VERIFY_PASSPHRASE){
      
     //Show custom UI to take user input for the passphrase.
     //Call validatePassphrase function with the user provided passphrase.
     
      const successCallback = data => {
        if (data.sessionId) {
          //Passphrase validated and LoggedIn Successfully
      }};
      
      const failureCallback = error => {
          console.error(error);
      };
       
      bayunCore.validatePassphrase(data.sessionId, "<passphrase>", null, successCallback, failureCallback);
    }
  }
};

const successCallback = data => {
  if (data.sessionId) {
    //LoggedIn Successfully
  }
};

const failureCallback = error => {
  console.error(error);
};

bayunCore.loginWithPassword(
    sessionId,
    companyName,
    companyEmployeeId,
    password,
    autoCreateEmployee,
    authorizeEmployeeCallback,
    securityQuestionsCallback,
    passphraseCallback,
    successCallback,
    failureCallback
);