authenticate()

Home > @gooddata/sdk-backend-spi > IAnalyticalBackend > authenticate

IAnalyticalBackend.authenticate() method

Triggers authentication process against the backend.

Signature:

authenticate(force?: boolean): Promise<IAuthenticatedPrincipal>;

Parameters

Parameter	Type	Description
force	boolean	(Optional) indicates whether authentication should be forced = must always be done even if the current session is already authenticated; defaults to false

Returns:

Promise<IAuthenticatedPrincipal>

promise of authenticated principal, or rejection if authentication has failed.

Remarks

If the 'force' parameter is specified, then the method MUST always lead to a call to the authentication provider.

If the 'force' parameter is not specified, then the method MAY lead to a call to the authentication provider - if the backend lives in an already authenticated session, principal is returned. If the session is not authenticated, then the provider WILL BE called.