Abstract
Static
nextRequests the next step in the authentication tree.
Call FRAuth.next()
recursively. At each step, check for session token or error, otherwise
populate the step's callbacks and call next()
again.
Example:
async function nextStep(previousStep) {
const thisStep = await FRAuth.next(previousStep);
switch (thisStep.type) {
case StepType.LoginSuccess:
const token = thisStep.getSessionToken();
break;
case StepType.LoginFailure:
const detail = thisStep.getDetail();
break;
case StepType.Step:
// Populate `thisStep` callbacks here, and then continue
thisStep.setInputValue('foo');
nextStep(thisStep);
break;
}
}
Optional
previousStep: FRStepThe previous step with its callback values populated
Optional
options: StepOptionsConfiguration overrides
The next step in the authentication tree
Static
redirectRedirects to the URL identified in the RedirectCallback and saves the full step information to localStorage for retrieval when user returns from login.
Example:
forgerock.FRAuth.redirect(step);
Static
resumeResumes a tree after returning from an external client or provider. Requires the full URL of the current window. It will parse URL for key-value pairs as well as, if required, retrieves previous step.
Example;
forgerock.FRAuth.resume(window.location.href)
Optional
options: StepOptionsStatic
startRequests the first step in the authentication tree. This is essentially an alias to calling FRAuth.next without a previous step.
Optional
options: StepOptionsConfiguration overrides
The next step in the authentication tree
Provides access to the OpenAM authentication tree API.