gcgov / framework-service-auth-ms-front
Plugins enables the exchange of a Microsoft access token for an application access token. The service assumes the user's front end will handle the authentication flow to acquire and manage the expiration of the Microsoft access token. When the framework app's token expires, user must re-exchange a
Installs: 1
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:framework-service
Requires
- php: >=8.1
This package is auto-updated.
Last update: 2024-05-07 15:43:10 UTC
README
Service to extend gcgov/framework
Primary purpose
- Enable the exchange of a Microsoft access token for an application access token. The service assumes the user's front end will handle the authentication flow to acquire and manage the expiration of the Microsoft access token. When the framework app's token expires, user must re-exchange a valid Microsoft access token for an updated app access token. There are no app refresh tokens or mechanisms.
Impact to application
- Router:
- Adds route
/.well-known/jwks.json
- provides endpoint to enable front end validation of tokens generated by the api - Adds route
/auth/microsoft
- exchanges a valid Microsoft authentication token for an app access - Adds route
/auth/fileToken
- create a short lived access token that can be used in the url for supported routes
- Adds route
Installation:
- Require using Composer https://packagist.org/packages/gcgov/framework-service-auth-ms-front
- Add namespace
\gcgov\framework\services\authmsfront
to\app\app->registerFrameworkServiceNamespaces()
Implementation
- Requests to
/auth/microsoft
must provideAuthorization
header with the valid Microsoft access token. ExAuthorization: Bearer {microsoft_token}
- Response body:
{ 'access_token':'-app_access_token-', 'expires_in':3600, 'token_type':'Bearer' }