Skip to main content

A msal-based authentication library for Microsoft Agents

Project description

Microsoft Agents MSAL Authentication

PyPI version

Provides secure authentication for your agents using Microsoft Authentication Library (MSAL). It handles getting tokens from Azure AD so your agent can securely communicate with Microsoft services like Teams, Graph API, and other Azure resources.

What is this?

This library is part of the Microsoft 365 Agents SDK for Python - a comprehensive framework for building enterprise-grade conversational AI agents. The SDK enables developers to create intelligent agents that work across multiple platforms including Microsoft Teams, M365 Copilot, Copilot Studio, and web chat, with support for third-party integrations like Slack, Facebook Messenger, and Twilio.

Release Notes

Version Date Release Notes
1.1.0 2026-06-19 1.1.0 Release Notes
1.0.0 2026-05-22 1.0.0 Release Notes
0.9.0 2026-04-15 0.9.0 Release Notes
0.8.0 2026-02-23 0.8.0 Release Notes
0.7.0 2026-01-21 0.7.0 Release Notes
0.6.1 2025-12-01 0.6.1 Release Notes
0.6.0 2025-11-18 0.6.0 Release Notes
0.5.0 2025-10-22 0.5.0 Release Notes

Packages Overview

We offer the following PyPI packages to create conversational experiences based on Agents:

Package Name PyPI Version Description
microsoft-agents-activity PyPI Types and validators implementing the Activity protocol spec.
microsoft-agents-hosting-core PyPI Core library for Microsoft Agents hosting.
microsoft-agents-hosting-aiohttp PyPI Configures aiohttp to run the Agent.
microsoft-agents-hosting-teams PyPI Provides classes to host an Agent for Teams.
microsoft-agents-hosting-dialogs PyPI Dialog system with waterfall dialogs, prompts, and multi-turn conversation management.
microsoft-agents-storage-blob PyPI Extension to use Azure Blob as storage.
microsoft-agents-storage-cosmos PyPI Extension to use CosmosDB as storage.
microsoft-agents-authentication-msal PyPI MSAL-based authentication for Microsoft Agents.

Additionally we provide a Copilot Studio Client, to interact with Agents created in CopilotStudio:

Package Name PyPI Version Description
microsoft-agents-copilotstudio-client PyPI Direct to Engine client to interact with Agents created in CopilotStudio

Installation

pip install microsoft-agents-authentication-msal

Quick Start

Basic Setup with Client Secret

Define your client secrets in the ENV file

CONNECTIONS__SERVICE_CONNECTION__SETTINGS__CLIENTID=client-id
CONNECTIONS__SERVICE_CONNECTION__SETTINGS__CLIENTSECRET=client-secret
CONNECTIONS__SERVICE_CONNECTION__SETTINGS__TENANTID=tenant-id

Load the Configuration (Code from main.py Quickstart Sample)

from .start_server import start_server

start_server(
    agent_application=AGENT_APP,
    auth_configuration=CONNECTION_MANAGER.get_default_connection_configuration(),
)

Then start the Agent (code snipped from (start_server.py Quickstart Sample](https://github.com/microsoft/Agents/blob/main/samples/python/quickstart/src/start_server.py)):

def start_server(
    agent_application: AgentApplication, auth_configuration: AgentAuthConfiguration
):
    async def entry_point(req: Request) -> Response:
        agent: AgentApplication = req.app["agent_app"]
        adapter: CloudAdapter = req.app["adapter"]
        return await start_agent_process(
            req,
            agent,
            adapter,
        )
[...]

Authentication Types

The M365 Agents SDK in Python supports the following Auth types:

class AuthTypes(str, Enum):
    certificate = "certificate"
    certificate_subject_name = "CertificateSubjectName"
    client_secret = "ClientSecret"
    user_managed_identity = "UserManagedIdentity"
    system_managed_identity = "SystemManagedIdentity"

Key Classes

  • MsalAuth - Core authentication provider using MSAL
  • MsalConnectionManager - Manages multiple authentication connections

Features

Multiple auth types - Client secret, certificate, managed identity
Token caching - Automatic token refresh and caching
Multi-tenant - Support for different Azure AD tenants
Agent-to-agent - Secure communication between agents
On-behalf-of - Act on behalf of users

Security Best Practices

  • Store secrets in Azure Key Vault or environment variables
  • Use managed identities when possible (no secrets to manage)
  • Regularly rotate client secrets and certificates
  • Use least-privilege principle for scopes and permissions

Quick Links

Sample Applications

Explore working examples in the Python samples repository:

Name Description README
Quickstart Simplest agent Quickstart
Auto Sign In Simple OAuth agent using Graph and GitHub auto-signin
OBO Authorization OBO flow to access a Copilot Studio Agent obo-authorization
Semantic Kernel Integration A weather agent built with Semantic Kernel semantic-kernel-multiturn
Streaming Agent Streams OpenAI responses azure-ai-streaming
Copilot Studio Client Console app to consume a Copilot Studio Agent copilotstudio-client
Cards Agent Agent that uses rich cards to enhance conversation design cards

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file microsoft_agents_authentication_msal-1.2.0.dev7.tar.gz.

File metadata

File hashes

Hashes for microsoft_agents_authentication_msal-1.2.0.dev7.tar.gz
Algorithm Hash digest
SHA256 cc8ef0ac699705152f8f92c9772f20bb5fb5f5526d35e3396e83cdd835d64bc3
MD5 7a274ef4afd8d94e7a3f852678524573
BLAKE2b-256 7f14a0bb7e9bd10f42ff5886621c0476f146f9e0bf0bcd2e56f1fb6e10f08859

See more details on using hashes here.

File details

Details for the file microsoft_agents_authentication_msal-1.2.0.dev7-py3-none-any.whl.

File metadata

File hashes

Hashes for microsoft_agents_authentication_msal-1.2.0.dev7-py3-none-any.whl
Algorithm Hash digest
SHA256 362519c2a44cea43c0bbc06114c51608f1da80bd247e4edd4fdf51e81212a020
MD5 ee051d09a3c5034ea28524862ad6a959
BLAKE2b-256 3429bda2944ae08843cb5f6756f6bea8c609721613ce74f7b8d184ea15a82d69

See more details on using hashes here.

Supported by

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