IAuthenticationProvider

Home > @gooddata/sdk-backend-spi > IAuthenticationProvider

IAuthenticationProvider interface

Defines authentication provider to use when instance of IAnalyticalBackend discovers that the current session is not authentication.

Signature:

export interface IAuthenticationProvider

Properties

PropertyTypeDescription
onNotAuthenticated?NotAuthenticatedHandler(Optional) Specify function to be called when the Analytical Backend raises a NotAuthenticated error.

Methods

MethodDescription
authenticate(context)Perform authentication.
deauthenticate(context)Clear existing authentication.
getCurrentPrincipal(context)Returns the currently authenticated principal, or undefined if not authenticated. Does not trigger authentication if no principal is available.
initializeClient(client)?(Optional) Perform custom initialization of the client that the Analytical Backend uses to communicate with the server.
← IAuthenticationContextIBackendCapabilities →