Type Alias OidcUser

Authenticated user handle scoped to an OIDC web client.

type OidcUser = {
    logout(): Promise<void>;
    refresh(): Promise<Omit<Tokens, "tokenExpiry">>;
    revoke(): Promise<void>;
    token(): Promise<Omit<Tokens, "tokenExpiry">>;
    userinfo(cache?: boolean): Promise<Record<string, unknown>>;
}

Index

Methods

logout refresh revoke token userinfo

Methods

logout

logout(): Promise<void>
Logout the current user session.

Returns Promise<void>
Remarks
Mirrors native OidcUser.logout() which does not return a value.
- Defined in packages/oidc/src/types/oidc.types.ts:238

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:218

revoke

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

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

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:213

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:225