Interface HttpAuthenticator

interface HttpAuthenticator {
    authenticate(
        req: IncomingMessage,
    ): AuthScope | Promise<AuthScope | null> | null;
}

Implemented by

Index

Methods

Methods

authenticate

authenticate(req: IncomingMessage): AuthScope | Promise<AuthScope | null> | null
Called for every inbound request. Returns the auth scope for the caller, or null/undefined if the request must be rejected with 401.
Parameters
- req: IncomingMessage
Returns AuthScope | Promise<AuthScope | null> | null