ActiveUI

ActiveUI

  • User Guide
  • Developer Documentation

Home > @activeviam/activeui-sdk > AuthenticationHolderImplementationProperties

AuthenticationHolderImplementationProperties interface

Exposes the authentication API that every part of ActiveUI requiring authentication can consume.

Signature:

export interface AuthenticationHolderImplementationProperties 

Properties

PropertyTypeDescription
getRequestOptions(url?: Url) => Promise<RequestInit>Resolves to the request options to use for each authenticated calls.
getSortedRoles() => SortedRolesReturns the roles of the currently logged in user.
getUsername() => Username | null | undefinedReturns the name of the currently logged in user.
invalidate(usedParameters: RequestInit) => Promise<void>Called with the fetch parameters used in the request that was rejected by the server. The holder should try to get a new value either from the user or from a broker.
logout(keepLogin?: boolean) => Promise<void>Indicate that the user has logged out. If keepLogin is true, ActiveUI will remember the name of the user and autofill it in the login popup of the next session.
  • AuthenticationHolderImplementationProperties interface
  • Properties
Copyright © 2019 ActiveViam