Socialite Providers
Maintained By GitHub icon ahaneef29
GitHub icon Github Repo
|
Edit

# UAEPass

composer require socialiteproviders/uaepass

# Set UAE PASS Environment

UAEPASS_BASE_URL="https://stg-id.uaepass.ae"
UAEPASS_CLIENT_ID="sandbox_stage"
UAEPAS_CLIENT_SECRET="sandbox_stage"
UAEPAS_REDIRECT_URI="http://my-app.test/callback"

# Installation & Basic Usage

Please see the Base Installation Guide (opens new window), then follow the provider specific instructions below.

# Add configuration to config/services.php

'uaepass' => [
    'base_url'      => env('UAEPASS_BASE_URL', 'https://stg-id.uaepass.ae'),
    'client_id'     => env('UAEPASS_CLIENT_ID'),
    'client_secret' => env('UAEPAS_CLIENT_SECRET'),
    'redirect'      => env('UAEPAS_REDIRECT_URI')
],

# Add provider event listener

# Laravel 11+

In Laravel 11, the default EventServiceProvider provider was removed. Instead, add the listener using the listen method on the Event facade, in your AppServiceProvider boot method.

  • Note: You do not need to add anything for the built-in socialite providers unless you override them with your own providers.
Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
    $event->extendSocialite('uaepass', \SocialiteProviders\UAEPPass\Provider::class);
});
Laravel 10 or below Configure the package's listener to listen for `SocialiteWasCalled` events.

Add the event to your listen[] array in app/Providers/EventServiceProvider. See the Base Installation Guide (opens new window) for detailed instructions.

protected $listen = [
    \SocialiteProviders\Manager\SocialiteWasCalled::class => [
        // ... other providers
        \SocialiteProviders\UAEPass\UAEPassExtendSocialite::class.'@handle',
    ],
];

# Usage

You should now be able to use the provider like you would regularly use Socialite (assuming you have the facade installed):

return Socialite::driver('uaepass')
->with(['acr_values' => 'urn:safelayer:tws:policies:authentication:level:low'])
->redirect();

# Returned User fields

  • uuid
  • sub
  • fullnameAR (same as full name arabic)
  • fullnameEN (same as full name english)
  • firstnameAR
  • lastnameAR
  • firstnameEN
  • lastnameEN
  • email
  • mobile
  • idn
  • gender
  • nationalityAR
  • nationalityEN
  • userType

← Binance →