Type Alias OidcClient

Native-backed OIDC client handle.

type OidcClient = {
    id: string;
    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

Methods

endSession refresh revoke token userinfo

Properties

id

id: string

Internal native identifier for the client.

Methods

endSession

endSession(): Promise<boolean>
End the current user session.

Returns Promise<boolean>
Whether the end-session flow completed successfully.
- Defined in packages/oidc/src/types/oidc.types.ts:203

refresh

refresh(): Promise<Omit<Tokens, "tokenExpiry">>
Force-refresh the token bundle.

Returns Promise<Omit<Tokens, "tokenExpiry">>
- Defined in packages/oidc/src/types/oidc.types.ts:184

revoke

revoke(): Promise<void>
Revoke the current token bundle.

Returns Promise<void>
- Defined in packages/oidc/src/types/oidc.types.ts:196

token

token(): Promise<Omit<Tokens, "tokenExpiry">>
Retrieve the current token bundle.

Returns Promise<Omit<Tokens, "tokenExpiry">>
- Defined in packages/oidc/src/types/oidc.types.ts:179

userinfo

userinfo(cache?: boolean): Promise<Record<string, unknown>>
Fetch user profile data from the userinfo endpoint.
Parameters
- Optionalcache: boolean
  When true, reuse cached userinfo if available.
Returns Promise<Record<string, unknown>>
- Defined in packages/oidc/src/types/oidc.types.ts:191