README

本包为 PHP League OAuth 2.0 Client 提供了 Jira OAuth 2.0 支持。

安装

安装时请使用 composer

composer require mrjoops/oauth2-jira

使用方法

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

授权码流

$provider = new Mrjoops\OAuth2\Client\Provider\Jira([
    'clientId'          => '{jira-client-id}',
    'clientSecret'      => '{jira-client-secret}',
    'redirectUri'       => 'https://example.com/callback-url',
]);

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->getNickname());

    } 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();
}

管理作用域

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

$options = [
    'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
    'scope' => ['read:jira-user','read:jira-work] // array or string
];

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

如果两者都没有定义，提供商将使用内部默认值。

在本文档编写时，以下作用域是可用的：

• read:jira-user
• read:jira-work
• write:jira-work
• manage:jira-project
• manage:jira-configuration

Jira Cloud API 调用

由于您的 Jira Cloud API URL 可能不同，您可以使用提供商的 getApiUrl() 方法获取。

$request = $provider->getAuthenticatedRequest(
    \Mrjoops\OAuth2\Client\Provider\Jira::METHOD_GET,
    $provider->getApiUrl().'/rest/api/3/myself',
    $token
);

测试

$ ./vendor/bin/phpunit

贡献

请参阅 CONTRIBUTING 以获取详细信息。

致谢

• Alexandre Lahure
• 所有贡献者

许可

MIT 许可证 (MIT)。请参阅 许可文件 以获取更多信息。