PHPackages                             un-ocha/oauth2-hid - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Authentication & Authorization](/categories/authentication)
4. /
5. un-ocha/oauth2-hid

ActiveLibrary[Authentication & Authorization](/categories/authentication)

un-ocha/oauth2-hid
==================

Humanitarian ID OAuth 2.0 Client Provider for The PHP League OAuth2-Client

v1.0.2(6y ago)357.5k↓43.9%1MITPHPCI failing

Since May 25Pushed 6y ago2 watchersCompare

[ Source](https://github.com/UN-OCHA/oauth2-hid)[ Packagist](https://packagist.org/packages/un-ocha/oauth2-hid)[ RSS](/packages/un-ocha-oauth2-hid/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (4)Versions (4)Used By (0)

Humanitarian ID Provider for OAuth 2.0 Client
=============================================

[](#humanitarian-id-provider-for-oauth-20-client)

[![Latest Version](https://camo.githubusercontent.com/7738146e9110a8607d6cfdd910be1a1b961644fee4982b593608ed26498f54e1/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f756e2d6f6368612f6f61757468322d6869642e7376673f7374796c653d666c61742d737175617265)](https://github.com/un-ocha/oauth2-hid/releases)[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)[![Build Status](https://camo.githubusercontent.com/2ea9817a933f3e97c9293396444a8a8624d3a92aab7c1c735c2dbcb42000006e/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f756e2d6f6368612f6f61757468322d6869642f6d61737465722e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/un-ocha/oauth2-hid)

This package provides Humanitarian ID OAuth 2.0 support for the PHP League's [OAuth 2.0 Client](https://github.com/thephpleague/oauth2-client).

Installation
------------

[](#installation)

To install, use composer:

```
composer require un-ocha/oauth2-hid

```

Usage
-----

[](#usage)

Usage is the same as The League's OAuth client, using `\League\OAuth2\Client\Provider\HumanitarianId` as the provider.

### Authorization Code Flow

[](#authorization-code-flow)

```
$provider = new League\OAuth2\Client\Provider\HumanitarianId([
    'clientId'          => '{hid-client-id}',
    'clientSecret'      => '{hid-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->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();
}
```

### Managing Scopes

[](#managing-scopes)

When creating your Humanitarian ID authorization URL, you can specify the state and scopes your application may authorize.

```
$options = [
    'state' => 'OPTIONAL_CUSTOM_CONFIGURED_STATE',
    'scope' => ['r_basicprofile','r_emailaddress'] // array or string
];

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

If neither are defined, the provider will utilize internal defaults.

At the time of authoring this documentation, the following scopes are available.

- r\_basicprofile
- r\_emailaddress
- rw\_company\_admin
- w\_share

Testing
-------

[](#testing)

```
$ ./vendor/bin/phpunit
```

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](https://github.com/un-ocha/oauth2-hid/blob/master/CONTRIBUTING.md) for details.

Credits
-------

[](#credits)

- [Guillaume Viguier-Just](https://github.com/guillaumev)
- [All Contributors](https://github.com/un-ocha/oauth2-hid/contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](https://github.com/un-ocha/oauth2-hid/blob/master/LICENSE) for more information.

###  Health Score

36

—

LowBetter than 82% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity33

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity65

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~247 days

Total

3

Last Release

2421d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/c4a5e307e7c5795ba841baaff3b2bdcc9e65a316c3fda591fa27f742da94a460?d=identicon)[guillaumev](/maintainers/guillaumev)

---

Top Contributors

[![guillaumev](https://avatars.githubusercontent.com/u/90224?v=4)](https://github.com/guillaumev "guillaumev (6 commits)")

---

Tags

clientoauthoauth2authorizationauthorisationhumanitarian id

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/un-ocha-oauth2-hid/health.svg)

```
[![Health](https://phpackages.com/badges/un-ocha-oauth2-hid/health.svg)](https://phpackages.com/packages/un-ocha-oauth2-hid)
```

###  Alternatives

[stevenmaguire/oauth2-keycloak

Keycloak OAuth 2.0 Client Provider for The PHP League OAuth2-Client

2275.9M27](/packages/stevenmaguire-oauth2-keycloak)[patrickbussmann/oauth2-apple

Sign in with Apple OAuth 2.0 Client Provider for The PHP League OAuth2-Client

1132.5M6](/packages/patrickbussmann-oauth2-apple)[mollie/oauth2-mollie-php

Mollie Provider for OAuth 2.0 Client

251.7M1](/packages/mollie-oauth2-mollie-php)[omines/oauth2-gitlab

GitLab OAuth 2.0 Client Provider for The PHP League OAuth2-Client

36721.5k13](/packages/omines-oauth2-gitlab)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)