Class UnifiAuth

constructor

• new UnifiAuth(props: IUnifiAuthProps, instance: AxiosInstance): UnifiAuth

• Parameters

  • props: IUnifiAuthProps
  • instance: AxiosInstance

  Returns UnifiAuth

autoReLogin

unifiOs

addInterceptorsToInstance

• addInterceptorsToInstance(instance: AxiosInstance): void

• Parameters

  • instance: AxiosInstance

  Returns void

getCookies

• getCookies(
      authenticationRequest?: boolean,
  ): Promise<(CookieSerializeOptions & { name: string; value: string })[]>

• Parameters

  • authenticationRequest: boolean = false

  Returns Promise<(CookieSerializeOptions & { name: string; value: string })[]>

getVersion

• getVersion(site?: string): Promise<undefined | string>

• Parameters

  • site: string = 'default'

  Returns Promise<undefined | string>

login

• login(token2FA?: string): Promise<IUser>

• Parameters

  • Optionaltoken2FA: string

    2FA token, will disable re-login

  Returns Promise<IUser>

logout

• logout(): Promise<void>

• Returns Promise<void>