Skip to main content

This is an authentication/authorization library, currently optimized for web apps. It provides some higher level APIs built on top of Microsoft's MSAL Python.

Project description

Identity library

This Identity library is an authentication/authorization library that:

  • Suitable for apps that are targeting end users on Microsoft identity platform, a.k.a. Microsoft Entra ID (which includes Work or school accounts provisioned through Azure AD, and Personal Microsoft accounts such as Skype, Xbox, Outlook.com).
  • Currently designed for web apps, regardless of which Python web framework you are using.
  • Provides a set of high level API that is built on top of, and easier to be used than Microsoft's MSAL Python library.
  • Written in Python, for Python apps.

DISCLAIMER: The code in this repo is not officially supported by Microsoft and is not intended for production use. The intention of this repo is to unblock customers who would like to use a higher level API, before such an API has been migrated to an Microsoft library with official support. Migration of this API to official support is not guaranteed and is not currently on the MSAL roadmap. Please ensure to fully test any code used from this repository to ensure it works in your environment.

Scenarios supported

Microsoft Entra ID Microsoft Entra External ID Microsoft Entra External ID with Custom Domain Azure AD B2C
App Registration

Following only the step 1, 2 and 3 of this Quickstart: Add sign-in with Microsoft to a Python web app

Follow only the page 1 of this Tutorial: Prepare your customer tenant ...

Coming soon.

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 AD B2C

Web App Sign In & Sign Out

By using this library, it will automatically renew signed-in session when the ID token expires.

How to customize the login page

The default login page will typically redirect users to your Identity Provider, so you don't have to customize it. But if the default login page is shown in your browser, you can read its HTML source code, and find the how-to instructions there.

Web App Calls a web API

This library supports:

  • Incremental consent. If the user needs to consent to more permissions, the library will automatically redirect the user to the consent page.
  • Automatically cache the access token and renew it when needed

They are demonstrated by the same samples above.

Web API Calls another web API (On-behalf-of)

In roadmap.

How to build the samples above from scratch

Read our docs here

Other scenarios

Upvote existing feature request or create a new one

Installation

This package is available on PyPI. Choose the package declaration that matches your web framework:

Note: Make sure you put "identity[...]" in quotes to ensure it works in all terminals.

  • Django: pip install "identity[django]"
  • Flask: pip install "identity[flask]"
  • Quart: pip install "identity[quart]"

Versions

This library follows Semantic Versioning. Your project should declare identity dependency with proper lower and upper bound.

You can find the changes for each version under Releases.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

identity-0.9.2.tar.gz (22.9 kB view details)

Uploaded Source

Built Distribution

identity-0.9.2-py3-none-any.whl (24.4 kB view details)

Uploaded Python 3

File details

Details for the file identity-0.9.2.tar.gz.

File metadata

  • Download URL: identity-0.9.2.tar.gz
  • Upload date:
  • Size: 22.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for identity-0.9.2.tar.gz
Algorithm Hash digest
SHA256 bd1808efa349d2150aa50d63823a2db89d0f6dc777d31ce5cb0f73c41ae12d73
MD5 4e1636b4c384c7ee4a38ef6dbf1d240a
BLAKE2b-256 57cefe1f0d8bdc5b0a3885ea18e4458bbe190e880e7fe7dfdc50151fdf9da2e7

See more details on using hashes here.

File details

Details for the file identity-0.9.2-py3-none-any.whl.

File metadata

  • Download URL: identity-0.9.2-py3-none-any.whl
  • Upload date:
  • Size: 24.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for identity-0.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 aa43aa0b802b50523e65e81550c860490d0c2c42c328821b8ea4be94450826be
MD5 83b6c662627cc399d1ec78512987da17
BLAKE2b-256 e737cd064252a558ae68afbc8937c6e98d7fc4df2cfb31af5fd39a899111dc43

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page