| page_type | languages | products | description | urlFragment | ||
|---|---|---|---|---|---|---|
sample |
|
|
A simple JavaScript Single-Page Application using the Auth Code flow w/ PKCE |
ms-identity-javascript-v2 |
This is a Proof of Concept (PoC) forked from Azure-Samples/ms-identity-javascript-v2 that demostrates how an app can support Azure AD (AAD) multi-tenant logins (i.e. work accounts from other AAD tenants) and B2B Guest logins.
- Use of separate AAD tenant to serve as control pane for B2B users for the app.
- Use of application specific roles defined in the registered AAD app's manifest.
- Emit those app roles as role claims within the OIDC id_token.
- Support SSO of work accounts (i.e. use of commmon endpoint) and B2B guest users (i.e. use of tenant specific endpoint) within the same app.
- Demostrate admin consent framework to accept the permissions of an app to access a tenant.
- Demostrate B2B users (without federation) request of the one time passcode to sign on to the app.
- Use of MS Graph to retrieve logged in user's profile for both B2B and Multi-tenant users.
- Use of MS Graph to the retrieve all users within an user's org which is only applicable for multi-tenant logins. By design, the users endpoint
https://graph.microsoft.com/v1.0/usersis not available for B2B guest accounts.
- 1. A user logins to the app from another AAD tenant,
- 2. A B2B guest user without federation logins to the app,
- 3. A B2B guest user with federation logins to the app
Consider the following configurations and settings for your own AAD tenent or providing this as education to your customers, when providing consent of multi-tenant applications.
- In preview, AAD now supports a admin consent workflow if enabled, see docs.
- To enforce that a user must be assigned to an app, go to Enterprise App > Properties and set User assignment required to Yes. Otherwise by default, all users of tenant will have access to the app.
- In preview, the B2B passcode invitation process can be enabled, see docs so invited guests with federation of their IDP will recieve a passcode to sign on the app. Upon log in, users will be prompted to provide a proper password.
A simple vanilla JavaScript single-page application which demonstrates how to configure MSAL.JS 2.x to login, logout, and acquire an access token for a protected resource such as Microsoft Graph API. This version of the MSAL.js library uses the Authorization Code flow w/ PKCE.
| File/folder | Description |
|---|---|
app |
Contains sample source files |
authPopup.js |
Main authentication logic resides here (using Popup flow). |
authRedirect.js |
Use this instead of authPopup.js for authentication with redirect flow. |
authConfig.js |
Contains configuration parameters for a Multi-tenant login for the sample. |
authConfig-b2bOverride.js |
Contains configuration parameters for a B2B login for the sample. |
graph.js |
Provides a helper function for calling MS Graph API. |
graphConfig.js |
Contains API endpoints for MS Graph. |
ui.js |
Contains UI logic. |
index.html |
Contains the UI of the sample. |
.gitignore |
Define what to ignore at commit time. |
changelog.md |
List of changes to the sample. |
CODE_OF_CONDUCT.md |
Code of Conduct information. |
CONTRIBUTING.md |
Guidelines for contributing to the sample. |
package.json |
Package manifest for npm. |
README.md |
This README file. |
LICENSE |
The license for the sample. |
SECURITY.md |
Security disclosures. |
server.js |
Implements a simple Node server to serve index.html. |
Node must be installed to run this sample.
- Register a new application in the Azure Portal. Ensure that the application is enabled for the authorization code flow with PKCE. This will require that you redirect URI configured in the portal is of type
SPA. - Open the /app/authConfig.js file and provide the required configuration values for Multi-tenant logins.
- Open the /app/authConfig-b2bOverride.js file and provide the required configuration values for B2B logins.
- On the command line, navigate to the root of the repository, and run
npm installto install the project dependencies via npm.
- Configure authentication and authorization parameters:
- Open
authConfig.js - Replace the string
"Enter_the_Application_Id_Here"with your app/client ID on AAD Portal. - Replace the string
"Enter_the_Multi-tenant_Login_Endpoint_Here"with"https://login.microsoftonline.com/organizations/"(note: This is for multi-tenant applications located on the global Azure cloud. For more information, see the documentation). - Replace the string
"Enter_the_Redirect_Uri_Here"with the redirect uri you setup on AAD Portal, e.g."http:https://localhost:3000/"" - Open
authConfig-b2bOverride.js - Replace the string
"Enter_the_TenantSpecific_Login_Endpoint_Here"with"https://login.microsoftonline.com/xxxx-xxxx-xxxx-xxxxx/"wherexxxx-xxxx-xxxx-xxxxxis the tenant Id.
- Open
- To start the sample application, run
npm start. - Open a browser to http:https://localhost:3000/index to test multi-tenant logins.
- Open a browser to http:https://localhost:3000/b2b-index to test B2B guest logins.
This sample demonstrates the following MSAL workflows:
- How to configure application parameters.
- How to sign-in with popup and redirect methods.
- How to sign-out.
- How to get user consent incrementally.
- How to acquire an access token.
- How to make an API call with the access token.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.