idall_in_app_authentication 0.0.6

A package to handle authorization with idall based on oAuth2

idall_in_app_authentication

A package to handle authorization with idall based on oAuth2. This plugin uses OAuth2 package which is a client library for authenticating with a remote service via OAuth2 on behalf of a user, and making authorized HTTP requests with the user's OAuth2 credentials.

For deep linking it uses native code to help with App/Deep Links (Android).

Getting Started

Installation

To use the plugin, add idall_authenticator as a dependency in your pubspec.yaml file.

Permission

Android and iOS require to declare links' permission in a configuration file.

For Android

You need to declare this filter in android/app/src/main/AndroidManifest.xml and make launchMode in activity tag singleInstance:

<manifest ...>
  <!-- ... other tags -->
  <application ...>
    <activity
    android:launchMode="singleInstance"
    >
      <!-- ... other tags -->

      <!-- Deep Links -->
      <intent-filter android:label="[YOUR_APPLICATION_NAME]">
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <data
          android:scheme="idall-flutter-auth"
          android:host="idall" />
      </intent-filter>

    </activity>
  </application>
</manifest>

For iOS

you need to declare this in ios/Runner/Info.plist (or through Xcode's Target Info editor, under URL Types):

<?xml ...>
<!-- ... other tags -->
<plist>
<dict>
  <!-- ... other tags -->
  <key>CFBundleURLTypes</key>
  <array>
    <dict>
      <key>CFBundleTypeRole</key>
      <string>Editor</string>
      <key>CFBundleURLName</key>
      <string>idall</string>
      <key>CFBundleURLSchemes</key>
      <array>
        <string>idall-flutter-auth</string>
      </array>
    </dict>
  </array>
  <!-- ... other tags -->
</dict>
</plist>

This allows for your app to be started from idall-flutter-auth://ANYTHING links.

Usage

introduce response model

return type of Idall authenticator is an enum: IdallResponseModes

enum IdallResponseModes{
  success, //this means operation succeeded, otherwise there is an error
  internalServerError, 
  requestTimeOut,
  badRequest,
  forbidden,
  methodNotAllowed,
  notFound,
  unauthorized,
  unsupportedMediaType,
  failedToParseJson,
  unknownError,
}

initializing

to set IdallAuthenticator use: setIdallConfig

 var res=await IdallAuthenticatorHelper().setIdallConfig('client_id','openid offline_access'); //define application scopes, 
//add openid if you want authorization, add offline_access if you want refresh token

to launch login page and get token from idall use: authenticate

var res=await IdallAuthenticatorHelper().authenticate();

use

to get access token, refresh token and expiration date use: getAccessToken, getRefreshToken, getAccessTokenExpirationDate

String accessToken= await IdallAuthenticatorHelper().getAccessToken();

String refreshToken= await IdallAuthenticatorHelper().getRefreshToken();

int accessTokenExpirationDate=  await IdallAuthenticatorHelper().getAccessTokenExpirationDate() ;

to see if client has access token: hasAccessToken

var hasToken= await IdallAuthenticatorHelper().hasAccessToken();

to refresh token use: refreshTokenIfExpired

var res= await IdallAuthenticatorHelper().refreshTokenIfExpired();

to force refresh token use: doRefreshToken

var res= await IdallAuthenticatorHelper().doRefreshToken();

to reset configs use: reset

await IdallAuthenticatorHelper().reset();