BasicAuthHandlerOptions | nextjs-api-common-middleware

[key: string]: any

Index

allowAnonymous: undefined | false | true

Enable if unauthorized access should still be possible and the middleware should populate the request with user information.

anonymousUserValue: any | null

If anonymous access is allowed, this value will be passed to req.user, defaults to null.

basic: (username?: undefined | string, password?: undefined | string) => Promise<UserInfo> | UserInfo

A function that will be called with the provided username and password. Grants access if this function evaluates to true.

- (username?: undefined | string, password?: undefined | string): Promise<UserInfo> | UserInfo
- Parameters
  - Optional username: undefined | string
  - Optional password: undefined | string
  Returns Promise<UserInfo> | UserInfo

headerName: undefined | string

Authorization header name, defaults to Authorization

strategy: "basic"

unauthorized: undefined | ((req: PossiblyAuthedNextApiRequest, res: NextApiResponse) => Promise<void> | void)

Override the default unauthorized responding behaviour.