journey/com.pingidentity.journey

Package-level declarations

Types

Link copied to clipboard
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.

Link copied to clipboard
typealias Journey = Workflow
Link copied to clipboard
class JourneyConfig : WorkflowConfig

JourneyConfig is a configuration class for the Journey workflow.

Link copied to clipboard
data class Option(var forceAuth: Boolean = false, var noSession: Boolean = false, parameters: MutableMap<String, Any> = mutableMapOf()) : MutableMap<String, Any>

Option class to configure additional options for the journey.

Link copied to clipboard
@Serializable
sealed interface SSOToken : Session

Properties

Link copied to clipboard
val <T : Any> Setup<T>.journey: Journey

Extension property to get the workflow from the Setup.

Link copied to clipboard
val Journey.options: JourneyConfig

Extension property to get the server URL from the JourneyConfig.

Functions

Link copied to clipboard
fun Journey(block: JourneyConfig.() -> Unit = {}): Journey

Creates a new Journey instance with the provided configuration block.

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

Resumes the authentication journey with the specified URI and options.

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

Starts the authentication journey with the specified options.

Link copied to clipboard
suspend fun Journey.user(): User?

Function to retrieve the user.