journey/com.pingidentity.journey

Package-level declarations

Types

class CallbackInitializer : Initializer<CallbackRegistry>

This class is responsible for registering callbacks in the application. It extends the Initializer interface, which means it is part of the initialization process of the application.

Journey

typealias Journey = Workflow

JourneyConfig

class JourneyConfig : WorkflowConfig

JourneyConfig is a configuration class for the Journey workflow.

Option

data class Option(var forceAuth: Boolean = false, var noSession: Boolean = false)

Option class to configure additional options for the journey.

SSOToken

@Serializable

sealed interface SSOToken : Session

Properties

journey

val <T : Any> Setup<T>.journey: Journey

Extension property to get the workflow from the Setup.

options

val Journey.options: JourneyConfig

Extension property to get the server URL from the JourneyConfig.

Functions

Journey

fun Journey(block: JourneyConfig.() -> Unit = {}): Journey

Creates a new Journey instance with the provided configuration block.

resume

suspend fun Journey.resume(uri: Uri, option: Option.() -> Unit = {}): Node

Resumes the authentication journey with the specified URI and options.

session

fun User.session(): SSOToken

start

suspend fun Journey.start(journeyName: String, option: Option.() -> Unit = {}): Node

Starts the authentication journey with the specified options.

user

suspend fun Journey.user(): User?

Function to retrieve the user.