vatsim/oauth2-vatsim

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

Maintainers

Details

github.com/vatsimnetwork/oauth2-vatsim-php

Source

Issues

Installs: 187

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 6

Forks: 1

Open Issues: 0

1.0.0 2023-01-22 23:46 UTC

Requires

Requires (Dev)

MIT b8ef34007c29da4ec5a2b02dff2c4648a372dbc6

authorizationAuthenticationclientoauthoauth2vatsim

This package is auto-updated.

Last update: 2024-04-23 06:18:40 UTC

README

Build Status License Latest Stable Version

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

Requirements

To use this package, it will be necessary to have a VATSIM Connect client ID and client secret.

Please follow the VATSIM Connect instructions to create the required credentials.

Installation

To install, use composer:

composer require vatsim/oauth2-vatsim

Usage

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

Available Options

The Vatsim provider has the following options:

  • domain allows for switching between the prod or dev Connect instance (default: https://auth.vatsim.net)

Scopes

At time of writing, available scopes are:

  • full_name - Full name (first and last)
  • email- Email address
  • country - Residence country
  • vatsim_details - VATSIM pilot rating, ATC rating, region, division, sub-division

Testing

Tests can be run with:

composer test

Style checks can be run with:

composer lint

Contributing

Please see CONTRIBUTING.md for details.

Credits

License

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