function
Source: auth.ts ↗
createTigerAuthenticationUrl()
Given tiger backend, authentication flow details and current location, this function creates URL where the browser should redirect to start authentication flow with correct return address.
export declare function createTigerAuthenticationUrl(backend: IAnalyticalBackend, authenticationFlow: AuthenticationFlow, location: Location, additionalParams?: {
externalProviderId?: string;
}): string;
Parameters
Parameter | Type | Description |
|---|---|---|
backend | an instance of analytical backend | |
authenticationFlow | details about the tiger authentication flow | |
location | Location | current location |
additionalParams | { externalProviderId?: string; } | (Optional) additional params used in the authentication URL |
Returns
string
Remarks
The current location is essential to determine whether the return redirect should contain absolute or related return path:
When running on same origin, then use relative path
When running on different origin, then use absolute path