Auth

The class for authorization into the backend.

Hierarchy

  • Auth

Constructors

Properties

routeForgotPassword: Route = ...
routeInvalidateAccountToken: Route = ...
routeInvalidateOrganizerToken: Route = ...
routeLogin: Route = ...
routeLoginToOrganizer: Route = ...
routeRegister: Route = ...
routeRegisterToOrganizer: Route = ...
routeSyncToOrganizer: Route = ...
routeValidateAccountToken: Route = ...
routeValidateOrganizerToken: Route = ...

Methods

  • Attempts to the log the user in, which will return their data and auth token

    See

    Authorization Login - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • data: object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

  • Attempts to login a user to an account that will be associated with an organizer. The organizer's auth token is required, and the JWT return will only work for resources associated with that organizer account.

    See

    Authorization Login To Organizer - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • data: object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

  • Attempts to register the user and will return their information along with an auth token.

    See

    Authorization Register - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • data: object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

  • Attempts to register a user that will be associated with an organizer account. The organizer's auth token is required, and the JWT return will only work for resources associated with that organizer account.

    See

    Authorization Register To Organizer - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • data: object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

  • If an account does not exist with an organizer, it will create one. Otherwise it will log the curent account into the organizer. This requires an organizer auth token.

    See

    Authorization Sync To Organizer - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • data: object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

Generated using TypeDoc