README

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

安装

要安装，请使用 composer

composer require stevenmaguire/oauth2-microsoft

用法

用法与 The League 的 OAuth 客户端相同，使用 \Stevenmaguire\OAuth2\Client\Provider\Microsoft 作为提供商。

授权码流

$provider = new Stevenmaguire\OAuth2\Client\Provider\Microsoft([
    // Required
    'clientId'                  => '{microsoft-client-id}',
    'clientSecret'              => '{microsoft-client-secret}',
    'redirectUri'               => 'https://example.com/callback-url',
    // Optional
    'urlAuthorize'              => 'https://login.windows.net/common/oauth2/authorize',
    'urlAccessToken'            => 'https://login.windows.net/common/oauth2/token',
    'urlResourceOwnerDetails'   => 'https://outlook.office.com/api/v1.0/me'
]);

if (!isset($_GET['code'])) {

    // If we don't have an authorization code then get one
    $authUrl = $provider->getAuthorizationUrl();
    $_SESSION['oauth2state'] = $provider->getState();
    header('Location: '.$authUrl);
    exit;

// Check given state against previously stored one to mitigate CSRF attack
} elseif (empty($_GET['state']) || ($_GET['state'] !== $_SESSION['oauth2state'])) {

    unset($_SESSION['oauth2state']);
    exit('Invalid state');

} else {

    // Try to get an access token (using the authorization code grant)
    $token = $provider->getAccessToken('authorization_code', [
        'code' => $_GET['code']
    ]);

    // Optional: Now you have a token you can look up a users profile data
    try {

        // We got an access token, let's now get the user's details
        $user = $provider->getResourceOwner($token);

        // Use these details to create a new profile
        printf('Hello %s!', $user->getFirstname());

    } catch (Exception $e) {

        // Failed to get user details
        exit('Oh dear...');
    }

    // Use this to interact with an API on the users behalf
    echo $token->getToken();
}

管理作用域和状态

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

$options = [
    'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
    'scope' => ['wl.basic', 'wl.signin'] // array or string
];

$authorizationUrl = $provider->getAuthorizationUrl($options);

如果没有定义任何一个，提供商将使用内部默认值。

编写此文档时，以下作用域可用。

核心

• wl.basic
• wl.offline_access
• wl.signin

扩展

• wl.birthday
• wl.calendars
• wl.calendars_update
• wl.contacts_birthday
• wl.contacts_create
• wl.contacts_calendars
• wl.contacts_photos
• wl.contacts_skydrive
• wl.emails
• wl.events_create
• wl.imap
• wl.phone_numbers
• wl.photos
• wl.postal_addresses
• wl.skydrive
• wl.skydrive_update
• wl.work_profile
• office.onenote_create

测试

$ ./vendor/bin/phpunit

贡献

有关详细信息，请参阅 CONTRIBUTING

致谢

• Steven Maguire
• 所有贡献者

许可协议

MIT 许可协议 (MIT)。有关更多信息，请参阅 许可文件