auth-foundation/com.okta.authfoundation.client/OidcConfiguration

OidcConfiguration

@Serializable

Deprecated

OidcConfiguration is deprecated in favor of the KMP OAuth2ClientBuilder, which works on Android and JVM. Use OAuth2ClientBuilder.create(issuerUrl, clientId, scope) to build a com.okta.authfoundation.client.kmp.OAuth2Client instead. This class will be removed in a future major release.

Configuration options for an OAuth2Client.

This class is used to define the configuration, as defined in your Okta application settings, that will be used to interact with the OIDC Authorization Server.

Constructors

OidcConfiguration

constructor(clientId: String, defaultScope: String, issuer: String)

Used to create an OidcConfiguration.

constructor(clientId: String, defaultScope: String, issuer: String, endpointOverrides: OAuth2EndpointOverrides?)

Used to create an OidcConfiguration with custom endpoint overrides.

Types

Companion

object Companion

Properties

accessTokenValidator

val accessTokenValidator: AccessTokenValidator

The AccessTokenValidator used to validate the Access Token when tokens are minted.

cacheFactory

val cacheFactory: suspend () -> Cache

The factory for creating a new instance of Cache. Cache is used to optimize network calls by the SDK.

clientId

val clientId: String

The application's client ID.

clock

val clock: OidcClock

The OidcClock which is used for all time related functions in the SDK.

computeDispatcher

val computeDispatcher: CoroutineContext

The CoroutineDispatcher which should be used for compute bound tasks.

defaultScope

val defaultScope: String

The default access scopes required by the client, can be overridden when logging in.

deviceSecretValidator

val deviceSecretValidator: DeviceSecretValidator

The DeviceSecretValidator used to validate the device secret when tokens are minted.

discoveryUrl

val discoveryUrl: String

The .well-known/openid-configuration endpoint associated with the Authorization Server. This is used to fetch the OidcEndpoints.

endpointOverrides

@Transient

val endpointOverrides: OAuth2EndpointOverrides?

Optional per-endpoint URL overrides. Non-null fields take precedence over discovery values. When all fields are non-null the discovery document fetch is skipped entirely. See OAuth2EndpointOverrides for details and URL validation rules.

eventCoordinator

@Transient

val ~~eventCoordinator~~: EventCoordinator

The EventCoordinator which the OAuth2Client should emit events to.

idTokenValidator

val idTokenValidator: IdTokenValidator

The IdTokenValidator used to validate the Id Token Jwt when tokens are minted.

ioDispatcher

val ioDispatcher: CoroutineContext

The CoroutineDispatcher which should be used for IO bound tasks.

json

@Transient