Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AuthService

Hierarchy

  • AuthService

Index

Constructors

Properties

Methods

Constructors

constructor

  • new AuthService(ethAddress?: undefined | string, password?: undefined | string): AuthService

Properties

Private API_URL

API_URL: any = ClientService.MYTHX_API_ENVIRONMENT

ethAddress

ethAddress: string

password

password: string

Methods

getChallenge

  • getChallenge(ethAddress?: undefined | string): Promise<any>

  • Generates authentication challenge (Metamask only for now). The Metamask flow needs to be handled on the front end since MythXJS does not have Web3 dependencies.

    Parameters

    • Optional ethAddress: undefined | string

      Ethereum address for Mythx account

    Returns Promise<any>

    Resolves with API response or throw error

getOpenApiHTML

  • getOpenApiHTML(): Promise<Openapi>

getOpenApiYAML

  • getOpenApiYAML(): Promise<any>

getStats

  • getStats(queryString?: undefined | string): Promise<Array<StatsResponse> | void>

getUsers

  • Retrieve list of registred API users or just caller user object if no required permission.

    Parameters

    • Default value queryString: string = ""

      Query string for detailed list (query parameters: offset, orderBy, email, ethAddress)

    Returns Promise<UsersResponse>

    Resolves with API response or throw error

getVersion

  • getVersion(): Promise<Version>

Private isUserLoggedIn

  • isUserLoggedIn(): boolean

login

  • login(ethAddress?: undefined | string, password?: undefined | string): Promise<JwtTokensInterface>

loginWithSignature

  • Login to the API using metamask challenge result message. In order to get the object containing the message, use getChallenge and handle Metamask login in the frontend.

    Parameters

    • signature: string

      message.value property contained in object returned from getChallenge.

    • Default value provider: string = "MetaMask"

      pass a provider value for the HTTP headers. If nothing is passed defaults to MetaMask

    Returns Promise<JwtTokensInterface>

    Returns an object containing two tokens (access+refresh) that can be saved in storage.

logout

  • logout(): Promise<__type>

Private setCredentials

Generated using TypeDoc