loicboursin/oauth2-microsoft-graph

为PHP League OAuth2-Client提供的Microsoft OAuth 2.0客户端提供程序

v1.0.3 2023-12-22 11:50 UTC

This package is auto-updated.

Last update: 2024-09-25 13:14:39 UTC


README

此软件包为PHP League的OAuth 2.0客户端提供了Microsoft Graph OAuth 2.0支持。

要求

以下版本的PHP兼容

  • PHP 8.2
  • PHP 8.1
  • PHP 8.0

新版本可能兼容,但尚未测试。

安装

要安装,请使用composer

composer require LoicBoursin/oauth2-microsoft-graph

用法

用法与The League的OAuth客户端相同,使用\LoicBoursin\OAuth2\Client\Provider\MicrosoftUser作为提供者。

管理作用域和状态

在创建您的Microsoft授权URL时,您可以指定您的应用程序可以授权的状态和作用域。

如果两者都没有定义,则提供程序将使用内部默认值。

在编写此文档时,以下作用域可用(最重要的)

  • openid
  • email
  • profile
  • (最终)User.Read

覆盖默认值

如果您需要覆盖默认值,例如授权URL或默认作用域,可以通过扩展提供程序并通过您自己的提供程序类覆盖所需的任何属性或方法来实现,例如

<?php

use LoicBoursin\OAuth2\Client\Provider\Microsoft;

class MyCustomMicrosoftProvider extends Microsoft
{
    protected string $urlAuthorize = 'https://login.microsoftonline.com/{TenantId}/oauth2/v2.0/authorize';
    protected string $urlAccessToken = 'https://login.microsoftonline.com/{TenantId}/oauth2/v2.0/token';
}

$urlAuthorize$urlAccessToken URL都设置为特定的租户ID身份验证端点,其中{TenantId}是租户ID占位符。这通常适用于特定于单个租户的应用程序注册/应用程序的认证,而不是多租户。默认的通用端点仅适用于启用了多租户的应用程序注册。

测试

$ make test

文件代码风格检查

$ make lint

鸣谢

许可证

MIT许可证(MIT)。有关更多信息,请参阅许可证文件