solid-client based on OAuth2/OpenID
This is an Authentication helper library that wraps an OpenID Connect (OIDC)
Relying Party library,
It is meant to be used in browser-side applications, as part of
Resolves to the WebID URI of the currently authenticated user, or
null if none
This SHOULD be checked either on page load or on whatever "Application is ready" event that your framework provides. For example:
// Using a standard "document loaded" event listener// (equivalent to jQuery's $(document).ready())document
Promise<string|null> login([string providerUri])
This is the main "authenticate to your favorite server/identity provider" action, which can be hooked up to whatever 'Login' button or link that your UI provides.
App developers will use it in one of two ways:
a) (typical) Your app does not provide its own Select Provider UI, so you can
.login() by itself with no parameter, which uses the built-in
provider selection UI.
b) Your app does provide its own Select Provider UI. In this case, you can
perform provider selection and pass in the
Called by itself (without a
login() does the following:
- If the user has already logged in, it resolves with their WebID URI
- Otherwise, opens a 'Select Provider' popup window, asking the user to select their identity provider (Solid server, pod, etc) to login to.
- The user makes their selection, and the popup closes and the current page
is redirected to that provider's
- When the user has gone through the local login process etc, they are
redirected back to the current page (from which
login() is called with a
providerUri argument, the Select Provider
popup window step is skipped, and the user proceeds directly to the auth
// You can bind any sort of Login button or link to do the following:solidClient
login() is successful, the following variables are set:
solidClient.auth.webIdis set to the current user's webId URI
solidClient.auth.accessTokenis set to the current user's access token
Promise<string> selectProvider ([string providerUri])
Clears the current user and tokens, and does a url redirect to the current RP client's provider's 'end session' endpoint. A redirect is done (instead of an ajax 'get') to enable the provider to clear any http-only session cookies.