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.
For more information on adaptive authentication, see Adaptive Authentication
The following sections present the core API reference for the JavaScript-based conditional authentication functions and fields.
Tip
As the authentication script is designed as a loosely typed, functional language similar to JavaScript, common knowledge on JavaScript may help you to compose effective authentication scripts.
Core functions¶
onLoginRequest(context)¶
This function is called when the initial authentication request is received by the framework. It includes the following parameters.
Parameter | Description |
---|---|
context | The authentication context, which contains the context information about the request. |
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.
Parameter | Description |
---|---|
stepId | The step number (mandatory) |
options | An optional map that can configure step execution. Authentication option filtering is supported. For more information, see authentication step filtering . |
eventCallbacks | The object that contains the callback functions that are to be called based on the result of the step execution. Supported results are “ onSuccess ” and “ onFail ”, which can have their own optional callbacks as anonymous functions (optional). |
The API can be called in either of the following ways:
-
With only the
stepId
. Example:executeStep(1)
-
With only the
stepId
andeventCallbacks
. Example:executeStep(1, { onSuccess: function(context) { //Do something on success } });
-
With the
stepId
,options
, and an emptyeventCallbacks
array. Different properties can be defined in theoptions
object such asauthenticationOptions
,authenticatorParams
. See the following two examples:executeStep(1,{ authenticationOptions:[{ authenticator: 'totp' }]}, }, {});
executeStep(1, { authenticatorParams: { local: { SessionExecutor: { MaxSessionCount: '1' }, totp: { enableRetryFromAuthenticator: 'true' } } } });
Note
The API cannot be called with only the
stepId
andoptions
.
Filters out some of the authentication options of a step based on a
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.
Example code
executeStep(1,{
authenticationOptions:[{authenticator:'basic'},{idp:'google'}]
},{
onSuccess: function (context) {
// Do something on success
};
Utility functions¶
The implementation of utility functions can be found in the WSO2 extensions code repository.
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.
Parameter | Description |
---|---|
user | A user object representing the user details. |
role | A string representing the role name. |
Example code
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.
Parameter | Description |
---|---|
user | An object representing the user details. |
assigningRoles | A list of strings containing roles that are to be assigned where each string is a role name. |
executeStep(1, {
onSuccess: function (context) {
// Extracting authenticated subject from the first step.
let user = context.currentKnownSubject;
assignUserRoles(user, ['exampleRole1', 'exampleRole2']);
}
});
removeUserRoles(user, removingRoles)¶
This function removes 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.
Parameter | Description |
---|---|
user | An object representing the user details. |
removingRoles | A list of strings that contains roles that are to be removed where each string is a role name. |
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.
Parameter | Description |
---|---|
user | An object representing the user details. |
templateId | Identifier of the email template. The email template specifies the body of the email that is sent out. |
placeholderParameters | Used to replace any placeholders in the template. |
Example code
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. It includes the following parameters.
Parameter | Description |
---|---|
url | The URL of the error page that the user is redirected to. If the value is null, the user is redirected by default to the ' retry.do' error page. Note that any relative URL is assumed as the relative to host’s root. |
parameters | Key value map passed as parameters. These are converted to query parameters in the URL. |
Example code
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.'});
}
Tip
When passing error messages to the error page, it is recommended to use the i18n key so that it can be internationalized easily at the page.
setCookie(response, name, value, properties)¶
This functions sets a new cookie. It includes the following parameters.
Parameter | Description |
---|---|
name | Name of the cookie. |
value | Value of the cookie. |
properties | A map that may contain optional attributes of the cookie with two other custom attributes ‘
|
Tip
The size of the value has to be less than the RSA key pair length if '
encrypt
' is enabled (set to
true).
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.
Parameter | Description |
---|---|
name | Name of the cookie. |
value | Value of the cookie. |
properties | A map that may contain optional attributes of the cookie ‘
|
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.
Parameter | Description |
---|---|
metadata | A JSON object that contain the following attributes:
|
payloadData | The data that needs to be sent to the analytics engine. |
eventHandlers | The callback event handlers. |
publishToAnalytics( metadata, payloadData )¶
This function publishes data to the analytics engine (WSO2 Stream Processor). It includes the following parameters.
Parameter | Description |
---|---|
metadata | A JSON object that contain the following attributes:
|
payloadData | The data that needs to be sent to the analytics engine. |
prompt(templateId, data, eventHandlers)¶
This function prompts for user input. It includes the following parameters.
Parameter | Description |
---|---|
templateId | Identifier of the template that needs to be prompted. |
data | The data to send to the prompt. |
eventHandlers | The callback event handlers. |
var onLoginRequest = function(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);
}
});
}
});
}
getUserSessions(user)¶
This function returns a session object (i.e. all the active user sessions of the specified user and returns an empty array if there are no sessions). It includes the following parameters.
Parameter | Description |
---|---|
user | This is a user object that represents the user details. |
var user = context.currentKnownSubject;
var sessions = getUserSessions(user);
for (var key in sessions) {
Log.info(“Session ID: ” + sessions[key].id);
}
terminateUserSession(user, sessionId)¶
This function returns a session object (i.e. all the active user sessions of the specified user and returns an empty array if there are no sessions). It includes the following parameters.
Parameter | Description |
---|---|
user | This is a user object that represents the user details. |
sessionId | This is the sessionId string of the session that needs to be terminated. |
var user = context.currentKnownSubject;
var sessions = getUserSessions(user);
if (sessions.length > 0) {
var result = terminateUserSession(user, sessions[0]);
Log.info(“Terminate Operation Successful?: ” + result);
}
getValueFromDecodedAssertion(String jwt, String parameterName,boolean isParameterInPayload)¶
This function returns a string which contains the value of the parameter in a decoded JWT. It includes the following parameters:
Parameter | Description |
---|---|
jwt | The jwt to be decoded. |
parameterName | The name of the parameter in the jwt for which the value should be retrieved. |
isParameterInPayload | Indicates whether the parameter to be retrieved is in the jwt header or body. Value should be true if the parameter to be retrieved is in the body . |
The following example shows how to obtain a parameter from the request object, which is a signed jwt.
var state = getValueFromDecodedAssertion(context.request.params.request[0],"state",true);
getUniqueUserWithClaimValues(claimMap, context, profile)¶
The utility function will search on 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 and get all users with the claim and add to list. Then remove the users from that list not having 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.
Parameter | Description |
---|---|
claimMap | A map contains the claim URI and claim value. |
context | The authentication context, which contains the context information about the request. |
parameterName | Profile of the user. (Optional, the default value is 'default') |
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.
Parameter | Description |
---|---|
federatedUser | The federated user object. |
doAssociationWithLocalUser(fedUser, localUsername, tenantDomain, userStoreDomain)¶
This function prompts user input. It includes the following parameters.
Parameter | Description |
---|---|
fedUser | Federated user object. |
localUsername | The username of the local user to be associated. |
tenantDomain | The tenant domain of the local user. |
userStoreDomain | The user store domain of the local user. |
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 ascarbon.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.claims[“<local_claim_url>”]
: (Read/Write) Sets a temporary claim value for the session.Note
- To use the
user.claims[“<local_claim_url>”]
property, apply the 0376 WUM update for WSO2 Identity Server 5.10.0 using the WSO2 Update Manager (WUM). To deploy a WUM update into production, you need to have a paid subscription. If you do not have a paid subscription, you can use this feature with the next version of WSO2 Identity Server when it is released. For more information on updating WSO2 Identity Server using WUM, see Getting Started with WUM. user.localClaims[“<local_claim_url>”]
updates the claim value in the user store as well.user.claims[“<local_claim_url>”]
is an alternative to set a claim for temporary basis only.
- To use the
-
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[0]
: Request’s parameter value for the given parameter name by the <param_name> index (param_name
is an array).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¶
response.headers[“<header_name>”]
: (Write) Response header value for the given header name by <header_name>
session Object¶
session.userAgent
: This is userAgent object of the user session.. See userAgent Object for more information.session.ip
: This is the session’s IP address.session.loginTime
: This is the session’s last login time.session.lastAccessTime
: This is the session’s last accessed time.session.id
: This is the session’s id.session.applications
: This is the list of application objects in the session. See application Object for more information.
application Object¶
application.subject
: This is the subject of the application.application.appName
: This is the name of the application.application.appId
: This is the id of the application.
userAgent Object¶
userAgent.raw
: This is the raw userAgent string.userAgent.browser
: This is the Web Browser property that is extracted from the raw userAgent string.userAgent.platform
: This is the Operating System property that is extracted from the raw userAgent string.userAgent.device
: This is the Device property that is extracted from the raw userAgent string.