mathieu-dumoutier/oauth2-orcid

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

dev-main 2022-09-27 12:19 UTC

This package is not auto-updated.

Last update: 2024-11-12 22:42:52 UTC


README

This package provides ORCID OAuth 2.0 support for the PHP League's OAuth 2.0 Client.

Installation

To install, use composer:

composer require mathieu-dumoutier/oauth2-orcid

Usage

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

knpuniversity/oauth2-client-bundle configuration example

knpu_oauth2_client:
    clients:
        orcid_oauth:
            type: generic
            provider_class: MathieuDumoutier\OAuth2\Client\Provider\Orcid
            provider_options:
                "scopes": '%env(ORCID_OAUTH_SCOPES)%'
                "use_member_api": '%env(ORCID_OAUTH_SANDBOX_MODE)%'
                "sandbox_mode": '%env(ORCID_OAUTH_MEMBER_API)%'
                "api_version": '%env(ORCID_OAUTH_API_VERSION)%'        
            client_id: '%env(ORCID_APP_ID)%'
            client_secret: '%env(ORCID_APP_SECRET)%'
            redirect_route: orcid_check
            redirect_params: {}
            use_state: false

You must define the 6 environment variables :

You must create the route "orcid_check".

Testing

$ ./vendor/bin/phpunit