ms-identity-python-webapp

KO | EN

gitlite — search

#python #hacktoberfest #react #typescript #llm #go #machine-learning #linux #windows #cli #kubernetes #pytorch #ios #open-source

ms-identity-python-webapp

(★ 324)

A Python web application calling Microsoft graph that is secured using the Microsoft identity platform

파일 탐색기

최종 버전 다운로드 (.zip)

- extensions.json
- AppCreationScripts.md
- Cleanup.ps1
- Configure.ps1
- sample.json
- display.html
- index.html
.env.sample.b2c
.env.sample.entra-id
.env.sample.external-id
.env.sample.external-id-custom-domain
.gitignore
app.py
app_config.py
auto-config.json
CODE_OF_CONDUCT.md
LICENSE
README.md
requirements.txt
SECURITY.md
test_app.py
topology.png
tox.ini

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

---
page_type: sample
languages:
- python
products:
- microsoft-entra-id
description: "This sample demonstrates a Python web application calling a Microsoft Graph that is secured using Microsoft Entra ID."
urlFragment: ms-identity-python-webapp
---
# Integrating Microsoft Entra ID with a Python web application written in Flask

This is a multi-purpose [Flask](https://flask.palletsprojects.com/en/3.0.x/) web app sample.
Write your app like this once, and the same implementation will support 4x2=8 scenarios.

|                | Microsoft Entra ID | External ID | External ID with Custom Domain | Azure Active Directory B2C |
|----------------|--------------------|-------------|--------------------------------|--------------|
| Web App Sign-In & Sign-Out |   ✓    |      ✓      |                ✓               |       ✓      |
| Web App Calls a web API |     ✓     |      ✓      |                ✓               |       ✓      |

![Topology](https://raw.githubusercontent.com/Azure-Samples/ms-identity-python-webapp-django/main/static/topology.png)

## Getting Started

### Prerequisites

1. Have [Python](https://python.org) 3.8+ installed
1. Clone from
   [its repo](https://github.com/Azure-Samples/ms-identity-python-webapp)
   or download its zip package, and then start using it or build on top of it.
1. `cd project_name`
1. Run `pip install -r requirements.txt` to install dependencies
1.  Run `flask run -h localhost` and then browse to http://localhost:5000
   You may need to change to a different port to match your redirect_uri setup.

### How to configure and use this sample

<table border=1>
  <tr>
    <th></th>
    <th>Microsoft Entra ID</th>
    <th>Microsoft Entra External ID</th>
    <th>Microsoft Entra External ID with Custom Domain</th>
    <th>Azure Active Directory B2C</th>
  </tr>

<tr>
    <th>App Registration</th>
    <td>

Following only the step 1, 2 and 3  of this
[Quickstart: Add sign-in with Microsoft to a Python web app](https://learn.microsoft.com/entra/identity-platform/quickstart-web-app-python-sign-in?tabs=windows)

</td>
    <td>

Follow only the page 1 of this [Tutorial: Prepare your customer tenant ...](https://learn.microsoft.com/entra/external-id/customers/tutorial-web-app-python-flask-prepare-tenant)

</td>
    <td>

Coming soon.

</td>
    <td>

Following only the step 1 and 2 (including 2.1 and 2.2) of this
[Configure authentication in a sample Python web app by using Azure Active Directory B2C](https://learn.microsoft.com/azure/active-directory-b2c/configure-authentication-sample-python-web-app?tabs=linux)

</td>
  </tr>

<tr>
    <th rowspan=2>Configuration</th>
    <td>

Copy this [Entra ID template](.env.sample.entra-id)
as `.env` and then modify `.env` with your app's settings.

</td>
    <td>

Copy this [External ID template](.env.sample.external-id)
as `.env` and then modify `.env` with your app's settings.

</td>
    <td>

Copy this [External ID with Custom Domain template](.env.sample.external-id-custom-domain)
as `.env` and then modify `.env` with your app's settings.

</td>
    <td>

Copy this [Azure Active Directory B2C template](.env.sample.b2c)
as `.env` and then modify `.env` with your app's settings.

</td>
  </tr>

Do not reverse the order of the configuration steps above.
If you put your app credentials into the template and then copy it into `.env`,
you risk accidentally committing your templates with credentials into Version Control System.

</td>
  </tr>

With the basic configuration above,
you can now browse to the index page of this sample to try the sign-in/sign-out experience.

</td>
  </tr>

<tr>
    <th>Web App Calls a web API</th>
    <td colspan=4>

Add the web API's *endpoint* into your `.env` file.
Also add the *scopes* it needs, separated by space.
The following example is the settings needed to call the Microsoft Graph API.
You may need to replace the their values with your own API endpoint and its scope..

```ini
ENDPOINT=https://graph.microsoft.com/v1.0/me
SCOPE=User.Read
```

Now restart this sample and try its "Call API" experience.

</td>
  </tr>

Deploy to
[Azure App Service](https://azure.microsoft.com/en-us/products/app-service)

</th>
    <td colspan=4>

* Follow the ["Quickstart: Deploy a Python (Django or Flask) web app to Azure App Service"](https://learn.microsoft.com/en-us/azure/app-service/quickstart-python),
  but replace its sample app (which does not do user sign-in) with this web app.
* [Configure your app's settings](https://learn.microsoft.com/en-us/azure/app-service/configure-common?tabs=portal#configure-app-settings)
  to define environment variables mentioned in the **Configuration** row of this table.
* If your `app_config.py` contains `SESSION_TYPE = "filesystem"`,
  you shall turn on "session affinity" (a.k.a. "ARR affinity") in your
  [App Service Web App's Configuration](https://learn.microsoft.com/en-us/azure/app-service/configure-common?tabs=portal#configure-general-settings)

</td>
  </tr>

</table>

## How to build this sample (or a new web project) from scratch

You can follow the
[instructions for Flask, from the underlying library](https://identity-library.readthedocs.io/en/latest/flask.html).

You can refer to the
[source code of this full sample here](https://github.com/Azure-Samples/ms-identity-python-webapp)
to pick up other minor details, such as how to modify `app.py` accordingly,
and how to add templates for the new view (and for the existing `index()` view).

## Contributing

If you find a bug in the sample, please raise the issue on [GitHub Issues](../../issues).

If you'd like to contribute to this sample, see [CONTRIBUTING.MD](/CONTRIBUTING.md).

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

ms-identity-python-webapp

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

ms-identity-python-webapp

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README