compwright/oauth2-fieldedge

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

v1.1.0 2024-12-03 19:06 UTC

Requires

• php: ^7.4 || ^8.0
• lcobucci/clock: ^3.3
• lcobucci/jwt: ^5.4
• league/oauth2-client: ^2.5
• psr/http-message: ^1.0 || ^2.0

Requires (Dev)

• phpunit/phpunit: ^9.6
• psr/http-message: ^1.1
• squizlabs/php_codesniffer: ^3.6

MIT

• Jonathon Hill

• authorization
• client
• oauth
• oauth2
• provider
• edge
• field
• authorisation

README

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

Installation

To install, use composer:

composer require compwright/oauth2-fieldedge league/oauth2-client

Usage

Usage is the same as The League's OAuth client, using \Compwright\OAuth2_Fieldedge\Provider as the provider.

Example: Client Credentials Flow

$provider = new Compwright\OAuth2_Fieldedge\Provider([
    'clientId'      => '{fieldedge-client-id}',
    'clientSecret'  => '{fieldedge-api-key}',
]);

// Get an access token
$token = $provider->getAccessToken('client_credentials');

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

// The token is really a JWT, getResourceOwnerId() extracts the company_id claim
echo $token->getResourceOwnerId();

Testing

$ make test

Contributing

Please see CONTRIBUTING for details.

Credits

• Jonathon Hill
• All Contributors

License

The MIT License (MIT). Please see License File for more information.