@asgardeo/auth-spa 0.4.3 → 0.4.6

package/README.md

@@ -15,6 +15,7 @@
 -   [Getting Started](#getting-started)
     -   [Using an Embedded Script](#using-an-embedded-script)
     -   [Using a Module](#using-a-module)
+    -   [Configuring Single Logout](#configuring-single-logout)
 -   [Try Out the Sample Apps](#try-out-the-sample-apps)
 -   [Browser Compatibility](#browser-compatibility)
 -   [APIs](#apis)
@@ -141,6 +142,19 @@ auth.on("sign-in", (response) => {
 
 [Learn more](#apis).
 
+### Configuring Single Logout
+
+Asgardeo allows the developers to add single logout capabilities to their applications. To configure single logout:
+
+1. Include following configs when initializing the `AsgardeoSPAClient` instance.
+   1. Set `enableOIDCSessionManagement` flag to `true` in order to enable single logout.
+   2. Adjust the `checkSessionInterval` value as needed to override the default interval. See [AuthClientConfig](#AuthClientConfigConfig) for more details.
+2. Ensure  [signIn( )](#signin) method is called with `{callOnlyOnRedirect: true}` when `signInRedirectURL` is loaded.
+
+```typescript
+    auth.signIn({callOnlyOnRedirect: true});
+```
+
 ## Try Out the Sample Apps
 
 ### 1. Create an Application in Asgardeo
@@ -401,6 +415,17 @@ The `sign-out` hook is used to fire a callback function after signing out is suc
 auth.signOut();
 ```
 
+**Clearing the locally stored user session happens when a sign-out hook is registered after the user gets redirected back to the `signOutRedirectURL`.**
+Therefore, the developer should ensure that a sign-out hook is registered when `signOutRedirectURL` is loaded. Refer the [example](#sign-out-hook-example) 
+for further details.
+
+#### Example
+```TypeScript
+// Register a sign-out hook with any callback function when signOutRedirectURL is loaded 
+// to clear locally stored user session
+auth.on("sign-out", () => {});
+```
+
 ---
 
 ### httpRequest
@@ -807,7 +832,6 @@ If you are using TypeScript, you may want to use the `Hooks` enum that consists
 **When the user signs out, the user is taken to the Asgardeo's logout page and then redirected back to the SPA on successful log out. Hence, developers should ensure that the `"sign-out"` hook is called when the page the user is redirected to loads.**
 
 #### Example
-
 ```TypeScript
 auth.on("sign-in", () => {
     // console.log(response);
@@ -979,7 +1003,6 @@ Of the four methods, storing the session information in the **web worker** is th
 ```TypeScript
 auth.initialize(config);
 ```
-
 ## Models
 
 ### AuthClientConfig\<Config>
@@ -990,7 +1013,7 @@ This table shows the extended attributes provided by the `Config` interface.
 | Attribute                     | Required/Optional                               | Type                                                | Default Value      | Description                                                                                                                                                                                                                                                                                                                                |
 |:------------------------------|:------------------------------------------------|:----------------------------------------------------|:-------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | [`storage`](#storage)         | Optional                                        | `"sessionStorage"`, `"webWorker"`, `"localStorage"` | `"sessionStorage"` | The storage medium where the session information such as the access token should be stored.                                                                                                                                                                                                                                                |
-| `resourceServerURLs`          | Required if the `storage` is set to `webWorker` | `string[]`                                          | `[]`               | The URLs of the API endpoints. This is needed only if the storage method is set to `webWorker`. When API calls are made through the [`httpRequest`](#httprequest) or the [`httpRequestAll`](#httprequestall) method, only the calls to the endpoints specified in the `baseURL` attribute will be allowed. Everything else will be denied. |
+| `resourceServerURLs`          | Required if the `storage` is set to `webWorker` | `string[]`                                          | `[]`               | The URLs of the API endpoints. This is required if the storage method is set to `webWorker`. Additionally, when API calls are made through the [`httpRequest`](#httprequest) or the [`httpRequestAll`](#httprequestall) method, only the calls to the endpoints specified either in `baseURL` or in `resourceServerURLs` attributes will be allowed. Everything else will be denied. |
 | `requestTimeout`              | Optional                                        | `number`                                            | 60000 (seconds)    | Specifies in seconds how long a request to the web worker should wait before being timed out.                                                                                                                                                                                                                                              |
 | `sessionRefreshInterval`      | Optional                                        | `number`                                            | 300 (seconds)      | Specifies how often the session state should be checked. To check the authentication state, the authorization endpoint is queried with the `prompt` parameter set to `none`.                                                                                                                                                               |
 | `checkSessionInterval`        | Optional                                        | `number`                                            | 3 (seconds)        | Specifies how often the check-session iFrame should be queried to check the session state. This is used to perform single logout.                                                                                                                                                                                                          |