oidc/com.pingidentity.oidc

Package-level declarations

Types

Agent

interface Agent<T>

The Agent is an interface that is used to authenticate and end a session with an OpenID Connect provider.

AuthCode

@Serializable

data class AuthCode(val code: String = "", val codeVerifier: String? = null)

Data class representing an authorization code.

Constants

object Constants

Constants for OIDC parameters.

DefaultAgent

object DefaultAgent : Agent<Unit>

Default implementation of the Agent interface.

DeviceAuthorizationResponse

@Serializable

data class DeviceAuthorizationResponse(val deviceCode: String, val userCode: String, val verificationUri: String, val verificationUriComplete: String? = null, val expiresIn: Int, val interval: Int = 5)

Data class representing the RFC 8628 device authorization response.

DeviceFlowStatus

sealed class DeviceFlowStatus

Sealed class representing the status of a device authorization flow (RFC 8628).

JsonConfigError

open class JsonConfigError(message: String) : Exception

Exception class for JSON configuration errors.

JsonConfigKey

object JsonConfigKey

JsonConfigParser

class JsonConfigParser(json: JsonObject)

A helper class for parsing JSON configuration with error handling.

OidcClient

open class OidcClient(config: OidcClientConfig)

Class representing an OpenID Connect client.

OidcClientConfig

class OidcClientConfig

Configuration class for OIDC client.

OidcConfig

class OidcConfig<T>

Allow the Agent to run on OidcConfig so that it can access the configuration object.

OidcDeviceClient

class OidcDeviceClient(config: OidcClientConfig)

OAuth 2.0 Device Authorization Grant client (RFC 8628).

OidcError

sealed class OidcError

Sealed class for OIDC errors.

OidcUser

class OidcUser(oidcClient: OidcClient) : User

Class for an OIDC User.

OidcWebClient

class OidcWebClient(val config: OidcWebClientConfig)

OIDC Web class. This class provides the OIDC authorization flow with a browser.

OidcWebClientConfig

class OidcWebClientConfig : WorkflowConfig

OIDC Web configuration class. Provide configuration for the OIDC web module.

OpenIdConfiguration

@Serializable

data class OpenIdConfiguration(var authorizationEndpoint: String = "", var pushAuthorizationRequestEndpoint: String = "", var tokenEndpoint: String = "", var userinfoEndpoint: String = "", var endSessionEndpoint: String = "", var pingEndIdpSessionEndpoint: String = "", var revocationEndpoint: String = "", var deviceAuthorizationEndpoint: String = "")

Data class representing the OpenID Connect configuration.

Parameters

class Parameters(val map: MutableMap<String, String>) : MutableMap<String, String>

Pkce

data class Pkce(val codeVerifier: String, val codeChallenge: String, val codeChallengeMethod: String)

Data class for PKCE (Proof Key for Code Exchange).

Token

@Serializable

data class Token(val accessToken: String = "", val tokenType: String? = null, val scope: String? = null, val expiresIn: Long = 0, val refreshToken: String? = null, val idToken: String? = null, expireAt: Long = now() + expiresIn)

Data class representing an OIDC token.

User

interface User

Interface for a User. Provides methods for token management, user information retrieval, and logout.

Functions

catch

inline fun <R> catch(block: () -> R): Result<R, OidcError>

Function to catch and handle exceptions.

OidcClient

inline fun OidcClient(block: OidcClientConfig.() -> Unit = {}): OidcClient

Factory function to create an instance of OidcClient with a given configuration.

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

Factory function to create an instance of OidcClient from a JSON configuration.

OidcDeviceClient

fun OidcDeviceClient(block: OidcClientConfig.() -> Unit = {}): OidcDeviceClient

Factory function to create an OidcDeviceClient with the provided configuration block.

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

Factory function to create an OidcDeviceClient from a JSON configuration object.

OidcWebClient

fun OidcWebClient(block: OidcWebClientConfig.() -> Unit = {}): OidcWebClient

Creates an instance of OidcWebClient with the provided configuration block.

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

Creates an instance of OidcWebClient from a JSON configuration.

toScopeSet

fun String.toScopeSet(): MutableSet<String>

Splits a comma-separated scope string into a mutable set of trimmed, non-blank scope values.

toScopesJsonArray

fun String.toScopesJsonArray(): <Error class: unknown class>

Converts a comma-separated scope string into a kotlinx.serialization.json.JsonArray of strings.

update

fun OidcClientConfig.update(oidcJsonConfig: JsonConfigParser)

Applies all optional OIDC fields from oidcJsonConfig to this OidcClientConfig.