0.0.0

oidc/com.pingidentity.oidc.module

Package-level declarations

Types

class UserDelegate(oidcFlow: OidcFlow, user: User, session: Session) : User, Session

Class representing a UserDelegate.

WebModuleConfig

class WebModuleConfig

Configuration class for the WebModule

Properties

val Oidc: Module<OidcClientConfig>

Oidc module for Workflow engine

populateDeviceFlowVerificationRequest

val populateDeviceFlowVerificationRequest: suspend OidcClientConfig.(HttpRequest, String) -> HttpRequest

Populates a request to verify a user code in the Device Authorization Grant flow (RFC 8628).

populateRequest

val populateRequest: suspend OidcClientConfig.(HttpRequest, Map<String, String>, Pkce) -> HttpRequest

Internal function to populate an OIDC authorization request with the necessary parameters.

val SuccessNode.user: User

Extension property for Success to cast the SuccessNode.session to a User.

VERIFICATION_URI_COMPLETE

const val VERIFICATION_URI_COMPLETE: String

Constant key used to pass the verification URI complete for the OAuth 2.0 Device Authorization Grant flow (RFC 8628). When this key is present in the flow context, the Oidc module will POST the user code to the device authorization endpoint after successful authentication.

val Web: Module<WebModuleConfig>

Functions

fun SharedContext.deviceUserCode(): String?

Returns the user_code query parameter from the VERIFICATION_URI_COMPLETE URI stored in this context, or null if the URI is absent or carries no user_code.

suspend fun OidcFlow.oidcUser(lookup: suspend OidcFlow.() -> User? = { prepareUser() }): User?

Function to retrieve the user.