Starting an authentication journey on iOS

PingOne Advanced Identity Cloud PingAM iOS

After instantiating the journey class and providing the configuration, you can call the start() method to begin an authentication journey.

When starting a journey you can supply the name of the journey as a parameter. If you do not specify a value the module launches the default journey in the server, often the Login journey.

The following example starts a journey named sdkUsernamePasswordJourney:

Starting a journey

let node = journey.start("sdkUsernamePasswordJourney")

You can optionally apply additional parameters when starting a journey:

Adding parameters when starting a journey

let node = journey.start("sdkUsernamePasswordJourney") { journeyConfig in
    journeyConfig.forceAuth = true
    journeyConfig.noSession = true
}

The parameters you might use in the start() method includes the following:

forceAuth: Set this parameter to true to force traversal of an authentication journey, even if the user already has a valid session.

Default is false.
noSession: Set this parameter to true to prevent the authentication journey from issuing a new session token upon successful completion.

Default is false.

Orchestration SDKs

Starting an authentication journey on iOS