OidcInteractionContext

@tsed/oidc-provider

Usage

import { OidcInteractionContext } from "@tsed/oidc-provider";

See /packages/security/oidc-provider/src/types/services/OidcInteractionContext.ts.

Overview

class OidcInteractionContext {
    protected env: Env | undefined;
    protected oidcProvider: OidcProvider;
    protected oidcInteractions: OidcInteractions;
    get $ctx(): PlatformContext<import("@tsed/platform-http").PlatformRequest<any>, import("@tsed/platform-http").PlatformResponse<any>>;
    get raw(): OidcInteraction;
    get session(): OidcSession | undefined;
    get prompt(): PromptDetail;
    get params(): Record<string, any>;
    get uid(): string;
    get grantId(): string;
    runInteraction(name?: string): Promise<void>;
    interactionDetails(): Promise<OidcInteraction>;
    interactionFinished(result: InteractionResults, options?: {
        mergeWithLastSubmission?: boolean;
    }): Promise<void>;
    interactionResult(result: InteractionResults, options?: {
        mergeWithLastSubmission?: boolean;
    }): Promise<string>;
    interactionPrompt({ client, ...options }: Record<string, any>): Promise<OidcInteractionPromptProps>;
    render(view: string, result: any): Promise<string>;
    save(ttl: number): Promise<string>;
    findClient(clientId?: string): Promise<OidcClient | undefined>;
    findAccount(sub?: string, token?: any): Promise<Account | undefined>;
    getGrant(): Promise<InstanceType<Provider["Grant"]>>;
    checkInteractionName(name: string): void;
    checkClientId(clientId?: any): Promise<void>;
    debug(obj?: any): any;
}

protected env

protected env: Env | undefined;

protected oidcProvider

protected oidcProvider: OidcProvider;

protected oidcInteractions

protected oidcInteractions: OidcInteractions;

get $ctx

get $ctx(): PlatformContext<import("@tsed/platform-http").PlatformRequest<any>, import("@tsed/platform-http").PlatformResponse<any>>;

get raw

get raw(): OidcInteraction;

get session

get session(): OidcSession | undefined;

get prompt

get prompt(): PromptDetail;

get params

get params(): Record<string, any>;

get uid

get uid(): string;

get grantId

get grantId(): string;

runInteraction

runInteraction(name?: string): Promise<void>;

interactionDetails

interactionDetails(): Promise<OidcInteraction>;

interactionFinished

interactionFinished(result: InteractionResults, options?: {
     mergeWithLastSubmission?: boolean;
 }): Promise<void>;

interactionResult

interactionResult(result: InteractionResults, options?: {
     mergeWithLastSubmission?: boolean;
 }): Promise<string>;

interactionPrompt

interactionPrompt({ client, ...options }: Record<string, any>): Promise<OidcInteractionPromptProps>;

render

render(view: string, result: any): Promise<string>;

save

save(ttl: number): Promise<string>;

findClient

findClient(clientId?: string): Promise<OidcClient | undefined>;

findAccount

findAccount(sub?: string, token?: any): Promise<Account | undefined>;

getGrant

getGrant(): Promise<InstanceType<Provider["Grant"]>>;

checkInteractionName

checkInteractionName(name: string): void;

checkClientId

checkClientId(clientId?: any): Promise<void>;

debug

debug(obj?: any): any;