Member Junction
    Preparing search index...

    Type Alias APIKeyActingContextResolver

    APIKeyActingContextResolver: (
        req: IncomingMessage | undefined,
        user: UserInfo,
        apiKeyId: string,
    ) =>
        | Promise<APIKeyActingContext | undefined>
        | APIKeyActingContext
        | undefined

    Resolves the acting context for one API-key request. Return undefined when the request carries no acting identity — filters requiring {{Acting*}} tokens then fail closed (match nothing / deny) by design.

    Type Declaration

      • (
            req: IncomingMessage | undefined,
            user: UserInfo,
            apiKeyId: string,
        ):
            | Promise<APIKeyActingContext | undefined>
            | APIKeyActingContext
            | undefined

      • Parameters

        • req: IncomingMessage | undefined

          The incoming HTTP request (undefined on transports without one, e.g. WebSocket connects)

        • user: UserInfo

          The per-request session UserInfo (already cloned; safe to read, do not mutate)

        • apiKeyId: string

          The validated API key's ID

        Returns Promise<APIKeyActingContext | undefined> | APIKeyActingContext | undefined

    Settings

    Member Visibility