authenticate
Authenticate a user to Venly
This function will check if the user is authenticated and if not, ask the user to authenticate.
1
venlyConnect.flows.authenticate({ windowMode: 'REDIRECT' });
Copied!
- If
windowMode= 'REDIRECT', the user will be redirected tooptions.redirectUriwith the result after logging in. - If
windowMode= 'POPUP', the popup will close and the promise resolved when the user finishes the request. No extra options are required.
If you set the
redirectUri option, make sure that the SDK and the AuthenticationResult handling is also present on the page you redirect to.Signature
1
venlyConnect.flows.authenticate(options?: AuthenticationOptions): Promise<AuthenticationResult>
Copied!
Returns
1
Promise<AuthenticationResult>
Copied!
Parameters
Parameter
Type
Required
Description
Examples
1
// Example 1
2
// Redirect to the current page
3
venlyConnect.flows.authenticate({ windowMode: 'REDIRECT' });
Copied!
1
// Example 2
2
// Redirect to https://foo.io
3
venlyConnect.flows.authenticate({ redirectUri: 'https://foo.io', windowMode: 'REDIRECT'});
Copied!
1
// Example 3
2
// Login using popup
3
venlyConnect.flows.authenticate({ windowMode: 'POPUP' })
4
.then((result: AuthenticationResult) => {
5
result
6
.authenticated((auth: KeycloakInstance) => {
7
alert('logged in: ' + auth.subject);
8
})
9
.notAuthenticated((auth: KeycloakInstance) => {
10
alert('not logged in');
11
});
12
});
Copied!
Object Types
Last modified 8mo ago
Copy link