express-openid-connect
    Preparing search index...

    Interface CustomTokenExchangeOptions

    Options for RequestContext.customTokenExchange. All fields are optional — unset fields fall back to authorizationParams config or RFC 8693 defaults where applicable.

    interface CustomTokenExchangeOptions {
        audience?: string;
        extra?: Record<string, string | number | boolean>;
        scope?: string;
        subject_token?: string;
        subject_token_type?: string;
    }
    Index

    Properties

    audience? extra? scope? subject_token? subject_token_type?

    Properties

    audience?: string

    Requested audience. Defaults to authorizationParams.audience.

    extra?: Record<string, string | number | boolean>

    Additional parameters forwarded to the token endpoint and can be used for vendor-specific or RFC 8693 extension parameters. Parameters in the security denylist are silently stripped.

    scope?: string

    Requested scope(s). Defaults to authorizationParams.scope.

    subject_token?: string

    The security token to exchange. Defaults to the current user's access token.

    subject_token_type?: string

    URI identifying the type of subject_token. Defaults to urn:ietf:params:oauth:token-type:access_token.

    Settings

    Member Visibility

    On This Page

    Properties