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 {
        actor_token?: string;
        actor_token_type?: string;
        audience?: string;
        extra?: Record<string, string | string[] | number | boolean>;
        organization?: string;
        requested_token_type?: string;
        scope?: string;
        subject_token?: string;
        subject_token_type?: string;
    }
    Index
    actor_token? actor_token_type? audience? extra? organization? requested_token_type? scope? subject_token? subject_token_type?
    actor_token?: string

    The actor token for delegation / impersonation exchanges (RFC 8693). When provided, actor_token_type is required. The resulting token will carry an act claim identifying the acting party.

    actor_token_type?: string

    URI identifying the type of actor_token (RFC 8693). Required when actor_token is provided.

    audience?: string

    Requested audience. Defaults to authorizationParams.audience.

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

    Additional parameters forwarded to the token endpoint. Useful for vendor-specific or RFC 8693 extension parameters. Parameters in the denylist are silently stripped.

    organization?: string

    Organization ID or name to scope the exchange to. When provided, the issued token will be bound to that organization.

    requested_token_type?: string

    URI specifying the type of token the caller wants the AS to issue (RFC 8693). e.g. urn:ietf:params:oauth:token-type:jwt

    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