Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface RegisterForMicrosoftOAuthOptions

Options for 'registerForMicrosoftOAuth()' function.

Hierarchy

  • RegisterForMicrosoftOAuthOptions

Index

Properties

Properties

onAccessToken

onAccessToken: (token: MicrosoftOAuthAccessToken, req: express.Request, res: express.Response) => void | PromiseLike<void>

Is invoked, when an access token has been received.

param

The token.

param

The request context.

param

The response context.

Type declaration

Optional onError

onError: (error: string, description: string, req: express.Request, res: express.Response) => any

A custom error response function.

param

The error (code).

param

The (error) description.

param

The request context.

param

The response context.

Type declaration

    • (error: string, description: string, req: express.Request, res: express.Response): any

    • Parameters

      • error: string
      • description: string
      • req: express.Request
      • res: express.Response

      Returns any

Optional onServerError

onServerError: (err: any, req: express.Request, res: express.Response) => any

A custom server error response function.

param

The error.

param

The request context.

param

The response context.

Type declaration

    • (err: any, req: express.Request, res: express.Response): any

    • Parameters

      • err: any
      • req: express.Request
      • res: express.Response

      Returns any

Optional onSuccess

onSuccess: (req: express.Request, res: express.Response) => any

A custom success response function.

param

The request context.

param

The response context.

Type declaration

    • (req: express.Request, res: express.Response): any

    • Parameters

      • req: express.Request
      • res: express.Response

      Returns any

Optional redirectPath

redirectPath: string

The custom redirect (base) path. Default: '/oauth/microsoft'

Generated using TypeDoc