Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthOobRoute

Hierarchy

  • AuthOobRoute

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

disabled

disabled: string[] = ['get', 'post', 'put']

endpoint

endpoint: string = "/auth/oob"

Methods

get

  • get(req: { query: { mode: string; oobCode: string } }): { operation: string; data: object }
  • Check an oob code

    Parameters

    • req: { query: { mode: string; oobCode: string } }
      • query: { mode: string; oobCode: string }
        • mode: string
        • oobCode: string

    Returns { operation: string; data: object }

    • operation: string
    • data: object
      • email: undefined | string

post

  • post(req: { body: { mode: string; newPassword?: undefined | string; oobCode: string } }): void
  • Handle oob actions

    Parameters

    • req: { body: { mode: string; newPassword?: undefined | string; oobCode: string } }
      • body: { mode: string; newPassword?: undefined | string; oobCode: string }
        • mode: string
        • Optional newPassword?: undefined | string
        • oobCode: string

    Returns void

put

  • put(req: { body: { email: string; mode: string } }): void
  • Send oob emails

    Parameters

    • req: { body: { email: string; mode: string } }
      • body: { email: string; mode: string }
        • email: string
        • mode: string

    Returns void

Generated using TypeDoc