Download the PHP package credit-union-2-0-llc/laravel-azure-ad-oauth without Composer
On this page you can find all versions of the php package credit-union-2-0-llc/laravel-azure-ad-oauth. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download credit-union-2-0-llc/laravel-azure-ad-oauth
More information about credit-union-2-0-llc/laravel-azure-ad-oauth
Files in credit-union-2-0-llc/laravel-azure-ad-oauth
Package laravel-azure-ad-oauth
Short Description Provides single-sign-on ability to Microsoft Azure Active Directory enabled apps.
License
Informations about the package laravel-azure-ad-oauth
Laravel Socialite Azure Active Directory Plugin
Installation
composer require metrogistics/laravel-azure-ad-oauth
If you are using Laravel 5.5 or greater, the service provider will be detected and installed by Laravel automatically. Otherwise you will need to add the service provider and the facade (optional) to the config/app.php
file:
Publish the config and override any defaults:
Add the necessary env vars:
The only changes you should have to make to your application are:
- You will need to make the password field in the users table nullable.
- You will need to have a
VARCHAR
field on the users table that is 36 characters long to store the Azure AD ID for the user. The default name for the field isazure_id
but that can be changed in the config file:'user_id_field' => 'azure_id',
.
Usage
All you need to do to make use of Azure AD SSO is to point a user to the /login/microsoft
route (configurable) for login. Once a user has been logged in, they will be redirect to the home page (also configurable).
After login, you can access the basic Laravel authenticate user as normal:
If you need to set additional user fields when the user model is created at login, you may provide a callback via the UserFactory::userCallback()
method. A good place to do so would be in your AppServiceProvider's boot
method:
Azure AD Setup
- Navigate to
Azure Active Directory
->App registrations
. - Create a new application
- Choose a name
- Select the "Web app / API" Application Type
- Add the "Sign-on URL". This will typically be
https://domain.com/auth/login
- Click "Create"
- Click into the newly created app.
- The "Application ID" is what you will need for your
AZURE_AD_CLIENT_ID
env variable. - Click into "Reply URLs". You will need to whitelist the redirection path for your app here. It will typically be
https://domain.com/login/microsoft/callback
. Click "Save" - Select the permissions required for you app in the "Required permissions" tab.
-
Add any necessary roles to the manifest:
- Click on the "Manifest" tab.
-
Add roles as necessary using the following format:
- Click "Save"
- In the "Keys" tab, enter a description (something like "App Secret"). Set Duration to "Never Expires". Click "Save". Copy the whole key. This will not show again. You will need this value for the
AZURE_AD_CLIENT_SECRET
env variable. - Click on the "Managed application" link (It will be the name of the application);
- Under the "Properties" tab, enable user sign-in. Make user assignment required. Click "Save".
- Under the "Users and groups" tab, add users and their roles as needed.
All versions of laravel-azure-ad-oauth with dependencies
laravel/socialite Version >3.0
guzzlehttp/guzzle Version ^6.3