ping-identity
    Preparing search index...

    Type Alias OidcClient

    Native-backed OIDC client handle.

    type OidcClient = {
        id: string;
        dispose(): Promise<void>;
        endSession(): Promise<boolean>;
        refresh(): Promise<Omit<Tokens, "tokenExpiry">>;
        revoke(): Promise<void>;
        token(): Promise<Omit<Tokens, "tokenExpiry">>;
        userinfo(cache?: boolean): Promise<Record<string, unknown>>;
    }
    Index

    Properties

    id

    Methods

    dispose endSession refresh revoke token userinfo

    Properties

    id: string

    Internal native identifier for the client.

    Methods

    • Deregister this client from CoreRuntime registries and release associated resources.

      Returns Promise<void>

      Handles accumulate until app kill if dispose is not called. Invoke when the client is no longer needed (e.g. on profile switch or component unmount).

    • Fetch user profile data from the userinfo endpoint.

      Parameters

      • Optionalcache: boolean

        When true, reuse cached userinfo if available.

      Returns Promise<Record<string, unknown>>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods