Download the PHP package ncit/efaas-socialite without Composer

On this page you can find all versions of the php package ncit/efaas-socialite. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of ncit/efaas-socialite

Informations about the package efaas-socialite

eFaas Laravel Socialite

Laravel Socialite Provider for eFaas.

Installation

You can install the package via composer:

Laravel 5.5 and above uses Package Auto-Discovery, so doesn't require you to manually add the ServiceProvider.

After updating composer, add the ServiceProvider to the providers array in config/app.php

Add configuration to config/services.php

Usage

You should now be able to use the provider like you would regularly use Socialite (assuming you have the facade installed): Refer to the Official Social Docs for more info.

Warning: If you get 403 Forbidden error when your Laravel app makes requests to the eFaas authorization endpoints, request NCIT to whitelist your server IP.

and in your callback handler, you can access the user data like so.

Logging out the eFaas User

In your Laravel logout redirect, redirect with the provider logOut() method using the access token saved during login

Using eFaas One-tap Login

This package will automatically add an /efaas-one-tap-login endpoint to your web routes which will redirect to eFaas with the eFaas login code.

Sometimes you may wish to customize the routes defined by the Efaas Provider. To achieve this, you first need to ignore the routes registered by Efaas Provider by adding EfaasProvider::ignoreRoutes to the register method of your application's AppServiceProvider:

Then, you may copy the routes defined by Efaas Provider in its routes file to your application's routes/web.php file and modify them to your liking:

Authenticating from mobile apps

To authenticate users from mobile apps, redirect to the eFaas login screen through a Web View on the mobile app. Then intercept the code (authorization code) from eFaas after they redirect you back to your website after logging in to eFaas.

Once your mobile app receives the auth code, send the code to your API endpoint. You can then get the eFaas user details from your server side using the auth code as follows:

After you receive the eFaas user, you can then issue your own access token or API key according to whatever authentication scheme you use for your API.

Changing the eFaas login prompt behaviour

The eFaas login prompt behaviour can be customized by modifying the prompt option on your redirect request

The available prompt options are:

Option Description
login Forces the user to enter their credentials on that request, regardless of whether the user is already logged into eFaas.
none Opposite of the login option. Ensures that the user isn't presented with any interactive prompt. If the request can't be completed silently by using single-sign on, the Microsoft identity platform returns an interaction_required error.
consent Triggers the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app.
select_account Interrupts the single sign-on, providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether

Available properties for eFaas User

All Available eFaas data fields

Field Description
id Efaas User Identifier
name Full Name Ahmed Mohamed
first_name First Name
middle_name Middle Name
last_name Last Name Mohamed
name_dhivehi Full Name In dhivehi Ahmed Mohamed
first_name_dhivehi First name in Dhivehi އަހުމަދު
middle_name_dhivehi Middle name in Dhivehi
last_name_dhivehi Last name in Dhivehi މުހައްމަދު
user_type User type
1- Maldivian
2- Work Permit Holder
3- Foreigners		 1
username ID number in case of maldivian and workpermit number in case of expatriates A037420
birthdate Date of birth. (Carbon instance) 10/28/1987
gender Gender M or F
email Email address [email protected]
mobile Registered phone number 9939900
photo User photo https://api.efaas.gov.mv/user/photo
passport_number Passport number of the individual (expat and foreigners only)
is_workpermit_active Is the work permit active false
permanentAddress Permananet Address. Country will contain an ISO 3 Digit country code. Ahmed
country user Country name Maldivian
countryCode user Country Code MDV
is_verified Whether User is verified or Not true or false
verification_type user verification type manual or face
updated_at Information Last Updated date. (Carbon instance) 10/28/2017

Testing

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Credits

License

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

All versions of efaas-socialite with dependencies

PHP Build Version
Package Version
Requires php Version >=7.2
laravel/socialite Version ~3.3|~4.0|~5.0
illuminate/http Version ^9.0|^10.0
illuminate/support Version ^5.6|^6.0|^7.0|^8.0|^9.0|^10.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package ncit/efaas-socialite contains the following files

Loading the files please wait ....