external-idp/com.pingidentity.idp.journey/IdpCallback

IdpCallback

class IdpCallback : AbstractCallback, JourneyAware, RequestInterceptor

Callback that handles authentication via external Identity Providers (IdPs).

This callback is responsible for processing authentication through third-party identity providers such as Google, Facebook, and Apple. It receives configuration parameters from the authentication server and uses the appropriate IdpHandler to complete the authentication flow.

The callback implements:

JourneyAware to access the parent journey
RequestInterceptor to add parameters to the request when submitting the callback

Constructors

IdpCallback

constructor()

Properties

acrValues

var acrValues: <Error class: unknown class>

Authentication Context Class References values. These can be used to request specific authentication methods or levels of assurance.

clientId

var clientId: String

The client ID to use when authenticating with the external identity provider. This is typically provided by the authentication server based on configured integrations with external providers.

intercept

open override var intercept: FlowContext.(HttpRequest) -> HttpRequest

Intercepts and modifies the request that will be sent to the authentication server. Adds any additional parameters received from the external identity provider.

journey

open lateinit override var journey: <Error class: unknown class>

Reference to the parent journey. Required by the JourneyAware interface.

nonce

var nonce: String

A random string used to mitigate CSRF attacks in OAuth flows. This value is validated when processing the authentication response.

provider

var provider: String

The external identity provider identifier (e.g., "google", "facebook", "apple"). This value is received from the server and determines which IdpHandler to use.

redirectUri

var redirectUri: String

The URI where the IdP should redirect after authentication. Used when configuring the external identity provider authentication flow.

request

var request: String

The JWT request object to be passed to the authorization server. Used in some OAuth/OIDC advanced flows.

requestUri

var requestUri: String

A URI that points to a JWT request object. Used as an alternative to the request parameter in some OAuth/OIDC flows.

scopes

var scopes: <Error class: unknown class>

The OAuth scopes to request from the external identity provider. These determine what information and permissions are requested from the user.

Functions

authorize

suspend fun authorize(redirectUri: Uri = "".toUri(), idpHandler: IdpHandler? = getIdpHandler(redirectUri)): Result<IdpResult>

Initiates the authentication flow with the external identity provider.

init

protected open override fun init(name: String, value: JsonElement)

Initializes the callback with data from the authentication server.

payload

open override fun payload(): JsonObject

Generates a JSON object payload to be sent back to the authentication server. This payload includes the token received from the external identity provider.