Skip to content

Commit b76c117

Browse files
Dickson-MwendiaDickson-Mwendia
committed
update docs
1 parent b35ec9e commit b76c117

20 files changed

+27
-51
lines changed

‎msal-javascript-conceptual/browser/access-token-proof-of-possession.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,4 +171,4 @@ Unlike other cache items, `Access Tokens` are saved to the cache asynchronously.
171171

172172
## Code samples
173173

174-
* [JavaScript SPA acquiring PoP tokens](../../../samples/msal-browser-samples/VanillaJSTestApp2.0/app/pop)
174+
* [JavaScript SPA acquiring PoP tokens](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-browser-samples/VanillaJSTestApp2.0/app/pop)

‎msal-javascript-conceptual/browser/accounts.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,7 @@ ms.reviewer: dmwendia,cwerner, owenrichards, kengaderdus
1212

1313
# Accounts in MSAL Browser
1414

15-
> This is the platform-specific Accounts documentation for `@azure/msal-browser`. For the general documentation of the `AccountInfo` object structure, please visit the `@azure/msal-common` [Accounts document](../../msal-common/docs/Accounts.md).
16-
17-
## Usage
18-
19-
The `@azure/msal-browser` library provides the following APIs to access cached accounts:
15+
This is the platform-specific Accounts documentation for the `@azure/msal-browser` library, which provides the following APIs to access cached accounts:
2016

2117
- `getAllAccounts()`: returns all the accounts currently in the cache. Supports an optional filter to return a specific set of accounts. An application must choose an account to acquire tokens silently.
2218
- `getAccount()`: returns the first cached account that matches the filter passed in. The order in which accounts are read from the cache is arbitrary and there is no guarantee that the first account in the filtered list will be the same for any two calls of `getAccount`. As explained below, increasing the number of filter attributes will provide more exact matches.
@@ -171,8 +167,8 @@ Note: As of version 2.16.0 the active account is stored in the cache ___location co
171167

172168
## Notes
173169

174-
- The current msal-browser default [sample](../../../samples/msal-browser-samples/VanillaJSTestApp2.0) has a working single account scenario.
175-
- If you have a multiple accounts scenario, please modify the [sample](../../../samples/msal-browser-samples/VanillaJSTestApp2.0/app/default/auth.js) (in `handleResponse()`) to list all cached accounts and choose a specific account.
170+
- The current msal-browser default [sample](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-browser-samples/VanillaJSTestApp2.0/) has a working single account scenario.
171+
- If you have a multiple accounts scenario, please modify the [sample](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-browser-samples/VanillaJSTestApp2.0/app/default/auth.js) (in `handleResponse()`) to list all cached accounts and choose a specific account.
176172
- If an application wants to retrieve an account based on the `username`, it needs to save the `username` (from the response of a `login` API for a specific user) prior to using `getAccountByUsername()` API.
177173
- `getAllAccounts()` will return multiple accounts if you have made several interactive token requests and the user has selected different accounts in two or more of those interactions. You may need to pass `prompt: "select_account"` or `prompt: "login"` to the interactive acquireToken or login API in order for AAD to display the account selection screen after the first interaction.
178174
- The account APIs return local account state and do not necessarily reflect server state. They return accounts that have previously signed into this app using MSAL.js and the server session may or may not still be active.

‎msal-javascript-conceptual/browser/configuration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -88,15 +88,15 @@ const msalInstance = new PublicClientApplication(msalConfig);
8888

8989
| Option | Description | Format | Default Value |
9090
| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
91-
| `clientId` | App ID of your application. Can be found in your [portal registration](../README#prerequisites). | UUID/GUID | None. This parameter is required in order for MSAL to perform any actions. |
91+
| `clientId` | App ID of your application. Can be found in your Azure Portal app registration pane | UUID/GUID | None. This parameter is required in order for MSAL to perform any actions. |
9292
| `authority` | URI of the tenant to authenticate and authorize with. Usually takes the form of `https://{uri}/{tenantid}` (see [Authority](../../msal-common/docs/authority.md)) | String in URI format with tenant - `https://{uri}/{tenantid}` | `https://login.microsoftonline.com/common` |
9393
| `knownAuthorities` | An array of URIs that are known to be valid. Used in B2C scenarios. | Array of strings in URI format | Empty array `[]` |
94-
| `cloudDiscoveryMetadata` | A string containing the cloud discovery response. Used in AAD scenarios. See [Performance](../../msal-common/docs/performance.md) for more info | string | Empty string `""` |
95-
| `authorityMetadata` | A string containing the .well-known/openid-configuration endpoint response. See [Performance](../../msal-common/docs/performance.md) for more info | string | Empty string `""` |
94+
| `cloudDiscoveryMetadata` | A string containing the cloud discovery response. Used in AAD scenarios. | string | Empty string `""` |
95+
| `authorityMetadata` | A string containing the .well-known/openid-configuration endpoint response. | string | Empty string `""` |
9696
| `redirectUri` | URI where the authorization code response is sent back to. Whatever ___location is specified here must have the MSAL library available to handle the response. | String in absolute or relative URI format | Login request page (`window.___location.href` of page which made auth request) |
9797
| `postLogoutRedirectUri` | URI that is redirected to after a logout() call is made. | String in absolute or relative URI format. Pass `null` to disable post logout redirect. | Login request page (`window.___location.href` of page which made auth request) |
9898
| `navigateToLoginRequestUrl` | If `true`, will navigate back to the original request ___location before processing the authorization code response. If the `redirectUri` is the same as the original request ___location, this flag should be set to false. | boolean | `true` |
99-
| `clientCapabilities` | Array of capabilities to be added to all network requests as part of the `xms_cc` claims request (see: [Client capability in MSAL](../../msal-common/docs/client-capability.md)) | Array of strings | [] |
99+
| `clientCapabilities` | Array of capabilities to be added to all network requests as part of the `xms_cc` claims request | Array of strings | [] |
100100
| `protocolMode` | Enum representing the protocol mode to use. If `"AAD"`, will function on the OIDC-compliant AAD v2 endpoints; if `"OIDC"`, will function on other OIDC-compliant endpoints. | string | `"AAD"` |
101101
| `azureCloudOptions` | A defined set of azure cloud options for developers to default to their specific cloud authorities, for specific clouds supported please refer to the [AzureCloudInstance](https://aka.ms/msaljs/azure_cloud_instance) | [AzureCloudOptions](https://azuread.github.io/microsoft-authentication-library-for-js/ref/modules/_azure_msal_common.html#azurecloudoptions) | [AzureCloudInstance.None](msaljs/azure_cloud_instance) |
102102
| `skipAuthorityMetadataCache` | A flag to choose whether to use the local metadata cache during authority initialization. Metadata cache would be used if no authority metadata is provided and before a network call for metadata has been made (see [Authority](../../msal-common/docs/authority.md)) | boolean | `false` |
@@ -126,7 +126,7 @@ See [Caching in MSAL](./caching.md) for more.
126126
| `asyncPopups` | Sets whether popups are opened asynchronously. When set to false, blank popups are opened before anything else happens. When set to true, popups are opened when making the network request. Can be set to true for scenarios where `about:blank` is not supported, e.g. desktop apps or progressive web apps | boolean | `false` |
127127
| `allowRedirectInIframe` | By default, MSAL will not allow redirect operations to be initiated when the application is inside an iframe. Set this flag to `true` to remove this check. | boolean | `false` |
128128
| `cryptoOptions` | Config object for crypto operations in the browser. | See [below](#crypto-config-options.) | See [below](#crypto-config-options.) |
129-
| `pollIntervalMilliseconds` | Interval of time in milliseconds between polls of popup URL hash during authenticaiton. | integer (milliseconds) | `30` |
129+
| `pollIntervalMilliseconds` | Interval of time in milliseconds between polls of popup URL hash during authentication. | integer (milliseconds) | `30` |
130130

131131
#### Logger Config Options
132132

‎msal-javascript-conceptual/browser/iframe-usage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Acquiring and using an access token
3-
description: Learn how to acquire and use an access token
2+
title: Using MSAL in iframed apps
3+
description: Learn how to use MSAL in iframed apps
44
author: EmLauber
55
manager: CelesteDG
66

‎msal-javascript-conceptual/browser/performance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
2-
title: Acquiring and using an access token
3-
description: Learn how to acquire and use an access token
2+
title: Measuring performance in MSAL.js
3+
description: Learn more about telemetry and performance of token acquisition in MSAL.js
44
author: EmLauber
55
manager: CelesteDG
66

‎msal-javascript-conceptual/browser/request-response-object.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: ARequest and Response Objects
2+
title: Request and Response Objects
33
description: Learn how to acquire and use an access token
44
author: EmLauber
55
manager: CelesteDG

‎msal-javascript-conceptual/browser/response.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

‎msal-javascript-conceptual/node/caching.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: EmLauber
55
manager: CelesteDG
66
ms.author: emilylauber
77

8-
ms.date: 04/26/2023
8+
ms.date: 11/28/2023
99
ms.service: active-directory
1010
ms.subservice: develop
1111
ms.topic: conceptual

‎msal-javascript-conceptual/node/certificate-credentials.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: EmLauber
55
manager: CelesteDG
66
ms.author: emilylauber
77

8-
ms.date: 04/26/2023
8+
ms.date: 11/28/2023
99
ms.service: active-directory
1010
ms.subservice: develop
1111
ms.topic: conceptual

‎msal-javascript-conceptual/node/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: EmLauber
55
manager: CelesteDG
66
ms.author: emilylauber
77

8-
ms.date: 04/26/2023
8+
ms.date: 11/28/2023
99
ms.service: active-directory
1010
ms.subservice: develop
1111
ms.topic: conceptual

0 commit comments

Comments
 (0)