Adaptive Authentication JS API Reference

With adaptive authentication, it is possible to configure dynamic sequences based on runtime parameters such as the user’s IP address, user role, etc. WSO2 Identity Server allows you to define a dynamic authentication sequence using authentication scripts written in JavaScript. 

The following sections present the core API reference for the JavaScript-based conditional authentication functions and fields. 

Core functions

onLoginRequest(context)

This function is called when the initial authentication request is received by the framework. It includes the following parameters.

executeStep(stepId, options, eventCallbacks)

This function is called to execute an authentication step. Authentication steps need to be configured prior to using this function. This method accepts an object as a parameter and should include the following.

The API can be called in either of the following ways:

• With only the stepId. Example:

  executeStep(1)

• With only the stepId and eventCallbacks. Example:

  executeStep(1, {
  	onSuccess: function(context) {
  		//Do something on success
  	}
  });

• With the stepId, options, and an empty eventCallbacks array. Example:

  executeStep(1,{
  	authenticationOptions:[{
  		authenticator: 'totp'
  	}]},
  });

  The API cannot be called with only the stepId and options .

Authentication step filtering

Filters out some of the authentication options of a step based on some condition. This can be achieved by specifying an array named ‘authenticationOptions’ to the options map. Each array item will require an ' idp' for federated IdPs or an ' authenticator' for local authenticators.

executeStep(1,{
  authenticationOptions:[{authenticator:'basic'},{idp:'google'}]
   } ,{
       onSuccess: function (context) {
           // Do something on success
};

Utility functions

hasRole(user, role)

This function returns true if the specified ‘ user ’ belongs to the specified ‘ role ', and returns false if the user does not. It includes the following parameters. 

var user = context.steps[1].subject;
var isAdmin = hasRole(user, 'admin');
Log.info('--------------- Has Admin ' + isAdmin);
if (isAdmin) {
    executeStep(2);
}

assignUserRoles(user, assigningRoles)

This function assigns each of the roles specified in the ‘ assigningRoles ’ parameter to the specified ‘ user ’ object. It returns true if all the roles are successfully assigned and returns false if not.  It includes the following parameters. 

executeStep(1, {
    onSuccess: function (context) {
        // Extracting authenticated subject from the first step.
        let user = context.currentKnownSubject;
        assignUserRoles(user, ['exampleRole1', 'exampleRole2']);
    }
});

This function r emoves each of the roles specified in the ‘ removingRoles ’ parameter to the given ‘ user ’ object. It returns true if all the roles are successfully removed and returns false if not. It includes the following parameters. 

executeStep(1, {
    onSuccess: function (context) {
        // Extracting authenticated subject from the first step.
        let user = context.currentKnownSubject;
        removeUserRoles(user, ['exampleRole1', 'exampleRole2']);
    }
});

sendEmail(user, templateId, placeholderParameters)

This function sends an email to the specified user. It includes the following parameters. 

var user = context.steps[1].subject;
var firstName = user.localClaims['http://wso2.org/claims/givenname'];
sendEmail(user, 'myTemplate', {'firstName':firstName});

sendError(url,parameters)

This function redirects the user to an error page indicating the end of the authorization flow. The error page includes the following parameters.

var user = context.steps[1].subject;
var isAdmin = hasRole(user, 'admin');
if (!isAdmin) {
    sendError('http://www.example.com/error',{'errorcode':'000403','errorMsg':'You are not allowed to login to this app.'});
}

setCookie(response, name, value, properties)

This functions sets a new cookie. It includes the following parameters. 

setCookie(context.response, "name", "test", {"max-age" : 4000,
											"path" : "/",
											"domain" : "localhost",
											"httpOnly" : true,
											"secure" : true,
											"version" : 1,
											"comment" : "some comments",
											"encrypt" : true,
											"sign" : true})

getCookieValue(request, name, properties)

This function gets the plain-text cookie value for the cookie ‘ name ’ if present.  It includes the following parameters. 

getCookieValue(context.request,"name", {"decrypt" : true,"validateSignature" : true })

callAnalytics( metadata, payloadData, eventHandlers )

This function calls the analytics engine (i.e., WSO2 Stream Processor) to get a decision. It includes the following parameters. 

publishToAnalytics( metadata, payloadData )

This function publishes data to the analytics engine (WSO2 Stream Processor). It includes the following parameters. 

prompt(templateId, data, eventHandlers)

This function prompts user input. It includes the following parameters. 

function onLoginRequest(context) {
   executeStep(1, {
       onSuccess: function (context) {
		   var username = context.steps[1].subject.username;
           prompt("genericForm", {"username":username, "inputs":[{"id":fname,"label":"First Name"},{"id":lname,"label":"Last Name"}]}, {
			 onSuccess : function(context) {
			    var fname = context.request.params.fname[0];
                var lname = context.request.params.lname[0];
			    Log.info(fname);
			    Log.info(lname);
			 }
		   });
       }
   });
}

getUniqueUserWithClaimValues(claimMap, context, profile)

This utility function will search the underlying user stores and return a unique user with the claim values. The claim map will consist of the claim and value. The function will get the 1st key from the map, get all users with the claim, and add them to the list. Then remove the users from that list who do not have the other claims. So the order of the map will decide the performance of this function. The first claim in this must have a low number of users.

This function prompts user input. It includes the following parameters. 

var claimMap = {};
claimMap[MAPPED_FEDERATED_USER_NAME_CLAIM] = federatedUserName;
claimMap[MAPPED_FEDERATED_IDP_NAME_CLAIM] = idpName;
var mappedUsername = getUniqueUserWithClaimValues(claimMap, context);

getAssociatedLocalUser(federatedUser)

This function prompts user input. It includes the following parameters. 

doAssociationWithLocalUser(fedUser, localUsername, tenantDomain, userStoreDomain)

This function prompts user input. It includes the following parameters. 

Object Reference

context Object

Contains the authentication context information. The information can be accessed as follows. 

• context.steps[<n>]:  Access the authentication step information, where <n> is the step number (1-based). See step Object for more information.

  Note: The step number is the one configured at the step configuration, not the actual order in which they get executed.

• context.request:  Access the HTTP authentication request information. See request Object for more information.
• context.response:  Access the HTTP response which will be sent back to the client. See response Object for more information.
• context.serviceProviderName:  Get the application name.

step Object

Contains the authentication step information. May be null or invalid step number.

• step.subject:  Contains the authenticated user’s information from this step. May be null if the step is not yet executed. See user Object for more information. 
• step.idp:  Gives the Idp name which was used to authenticate this user.

user Object

• user.username : (Read/Write) The user’s username.
• user.tenantDomain : (Read/Write) The user’s tenant domain (only for local users; federated users will have this as carbon.super).
• user.userStoreDomain : (Read/Write) The user’s user store domain (only for local users).
• user.roles : (Read/Write) List of user’s roles.
• user.localClaims[“<local_claim_url>”] : (Read/Write) User’s attribute (claim) value for the given “local_claim_url”. If the user is a federated user, this will be the value of the mapped remote claim from the IdP.
• user.remoteClaims[“<remote_claim_url”] : (Read/Write) User’s attribute (claim) as returned by IdP for the given “remote_claim_url”. Applicable only for federated users.

request Object

• request.headers[“<header_name>”] : Request’s header value for the given header name by <header_name>
• request.params[“<param_name>”] : Request’s parameter value for the given parameter name by <parameter_name>
• request.cookies[“<cookie_name”] : Request’s cookie value for the given cookie name by <cookie_name>
• request.ip : The client IP address of the user who initiated the request. If there are any load balancers (eg. Nginx) with connection termination, the ip is retrieved from the headers set by the load balancer.

response Object

• request.headers[“<header_name>”] : (Write) Response header value for the given header name by <header_name>