ping-identity
    Preparing search index...

    Type Alias OidcClientConfig

    OidcClientConfig: Omit<JourneyInstance, "signOutRedirectUri"> & {
        ios?: JourneyInstance;
        logger?: JourneyInstance;
        storage?: JourneyInstance;
    }

    Configuration for creating a native-backed OIDC client.

    Type Declaration

    • Optionalios?: JourneyInstance

      iOS-only browser configuration for OIDC web login.

      Mirrors Ping iOS SDK OidcWebConfig settings. Ignored on Android.

    • Optionallogger?: JourneyInstance

      Optional JavaScript logger instance.

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

    • Optionalstorage?: JourneyInstance

      Optional storage configuration created by the storage module.

      Pass the object returned by configureOidcStorage. The native layer uses the embedded id to resolve the registered storage configuration.

    Values are serialized across the React Native bridge and must remain platform-agnostic.

    Basic configuration:

    const client = createOidcClient({
      clientId: 'client-id',
      discoveryEndpoint: 'https://example.com/.well-known/openid-configuration',
      redirectUri: 'com.example.app://callback',
      scopes: ['openid', 'email', 'profile'],
    });

    With OpenID override and logger:

    const log = logger({ level: 'debug' });
    const client = createOidcClient({
      clientId: 'client-id',
      redirectUri: 'com.example.app://callback',
      scopes: ['openid'],
      openId: {
        authorizationEndpoint: 'https://issuer/authorize',
        tokenEndpoint: 'https://issuer/token',
        userinfoEndpoint: 'https://issuer/userinfo',
      },
      logger: log,
    });

    Settings

    Member Visibility