ping-identity
    Preparing search index...

    Type Alias DaVinciOidcModuleConfig

    OIDC module configuration nested under DaVinciModules.

    Contains the required OIDC identity fields and all optional OIDC authorization request parameters. Native SDK source of truth: OidcClientConfig on both Android and iOS.

    type DaVinciOidcModuleConfig = {
        acrValues?: string;
        additionalParameters?: Record<string, string>;
        clientId: string;
        discoveryEndpoint: string;
        display?: string;
        loginHint?: string;
        nonce?: string;
        prompt?: string;
        redirectUri: string;
        refreshThreshold?: number;
        scopes?: string[];
        signOutRedirectUri?: string;
        state?: string;
        storage?: JourneyInstance;
        uiLocales?: string;
    }
    Index

    Properties

    acrValues? additionalParameters? clientId discoveryEndpoint display? loginHint? nonce? prompt? redirectUri refreshThreshold? scopes? signOutRedirectUri? state? storage? uiLocales?

    Properties

    acrValues?: string

    Optional authentication context class reference values.

    Maps to OidcClientConfig.acrValues on both platforms.

    additionalParameters?: Record<string, string>

    Additional provider-specific authorization request parameters.

    Maps to OidcClientConfig.additionalParameters on both platforms.

    clientId: string

    OAuth2 client identifier registered with the OIDC provider.

    Maps to OidcClientConfig.clientId on both platforms.

    discoveryEndpoint: string

    OIDC discovery endpoint URL.

    Maps to OidcClientConfig.discoveryEndpoint on both platforms. Usually the .well-known/openid-configuration base URL of your PingOne tenant.

    display?: string

    Optional display parameter for the authorization request.

    Maps to OidcClientConfig.display on both platforms. Typical values: 'page', 'popup', 'touch', 'wap'.

    loginHint?: string

    Optional login hint forwarded to the authorization endpoint.

    Maps to OidcClientConfig.loginHint on both platforms.

    nonce?: string

    Optional nonce parameter for the authorization request.

    Maps to OidcClientConfig.nonce on both platforms.

    prompt?: string

    Optional prompt parameter for the authorization request.

    Maps to OidcClientConfig.prompt on both platforms. Typical values: 'login', 'consent', 'none', 'select_account'.

    redirectUri: string

    OAuth2 redirect URI registered for this client.

    Maps to OidcClientConfig.redirectUri on both platforms.

    refreshThreshold?: number

    Optional token refresh threshold in seconds.

    Maps to OidcClientConfig.refreshThreshold on both platforms. When the remaining token lifetime falls below this value, the SDK proactively refreshes the token on the next user() call.

    scopes?: string[]

    OAuth2 scopes to request.

    Maps to OidcClientConfig.scopes. Defaults to ['openid', 'profile'] when omitted.

    signOutRedirectUri?: string

    Sign-out redirect URI used for end-session flows.

    Maps to OidcClientConfig.signOutRedirectUri on Android. Not available on iOS OidcClientConfig in 2.0.1 — silently ignored on iOS until the iOS SDK exposes it.

    state?: string

    Optional state parameter for the authorization request.

    Maps to OidcClientConfig.state on both platforms.

    storage?: JourneyInstance

    Optional OIDC token storage handle created by the storage module.

    Must be created by @ping-identity/rn-storage (configureOidcStorage()).

    uiLocales?: string

    Optional space-separated list of end-user preferred UI locales.

    Maps to OidcClientConfig.uiLocales on both platforms.

    Settings

    Member Visibility

    On This Page

    Properties