GenericBearerAuthHandlerOptions | nextjs-api-common-middleware

GenericAuthHandlerOptions
- GenericBearerAuthHandlerOptions
  - DefaultBearerAuthHandlerOptions
  - CustomBearerAuthHandlerOptions

[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.

getUser: (userId: UserId) => Promise<UserInfo> | UserInfo

Provide a function that returns a user by its id.

- (userId: UserId): Promise<UserInfo> | UserInfo
- Parameters
  - userId: UserId
  Returns Promise<UserInfo> | UserInfo

headerName: undefined | string

Authorization header name, defaults to Authorization

strategy: "bearer"

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

Override the default unauthorized responding behaviour.