journey/com.pingidentity.journey/Journey

Journey

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

Creates a new Journey instance with the provided configuration block.

Return

A new Journey instance.

Parameters

block

The configuration block for the Journey.

fun Journey(json: JsonObject): Result<Journey>

Creates a Journey instance from a JSON configuration.

Journey-specific fields are nested under journey; OIDC fields under oidc. Example:

{
  "timeout": 30000,
  "log": "STANDARD",
  "journey": {
    "serverUrl": "https://openam.example.com/am",
    "realm": "alpha",
    "cookieName": "iPlanetDirectoryPro"
  },
  "oidc": {
    "clientId": "my-client-id",
    "discoveryEndpoint": "https://openam.example.com/am/oauth2/alpha/.well-known/openid-configuration",
    "scopes": ["openid", "profile"],
    "redirectUri": "myapp://oauth2redirect",
    "signOutRedirectUri": "myapp://logout",
    "refreshThreshold": 60,
    "loginHint": "user@example.com",
    "state": "custom-state",
    "nonce": "custom-nonce",
    "display": "page",
    "prompt": "login",
    "uiLocales": "en-US",
    "acrValues": "Level3",
    "par": true,
    "additionalParameters": { "max_age": "3600" },
    "openId": {
      "authorizationEndpoint": "https://openam.example.com/authorize",
      "tokenEndpoint": "https://openam.example.com/token",
      "userinfoEndpoint": "https://openam.example.com/userinfo",
      "endSessionEndpoint": "https://openam.example.com/logout",
      "revocationEndpoint": "https://openam.example.com/revoke"
    }
  }
}
Content copied to clipboard

Return

A Result containing the Journey instance or an exception if the configuration is invalid.

Parameters

json

The JSON configuration object.