Skip to main content


React Native OMH Auth - Microsoft

NPM downloadsNPM versionLicense

Chat on DiscordFollow on Twitter

Installation​

npm add @openmobilehub/auth-microsoft

Configuration​

Prerequisites

Each plugin requires you to follow the iOS and Android configuration prior to interacting with it.

Console App​

To access Google APIs, please follow these steps in order to obtain the Client ID:

  1. Create a new app in Microsoft Azure.
  2. Add the Android platform and specify your Package Name and Signature Hash for your app.
  3. Add the iOS / macOS platform and specify your Bundle ID for your app.
  4. Download the ms_auth_config.json file and add it in the android/app/src/main/res/raw directory.

Android​

Add a new entry to your android/local.properties file:

android/local.properties
MICROSOFT_HOST_PATH=<YOUR_ANDROID_PACKAGE_NAME>.MainApplication
MICROSOFT_SIGNATURE_HASH=<YOUR_MICROSOFT_SIGNATURE_HASH>

Usage​

Initializing​

Before interacting with Microsoft, initialization of the Microsoft Auth Client is necessary, requiring platform specific configuration to be set.

import MicrosoftAuthClient from '@openmobilehub/auth-microsoft';

await MicrosoftAuth.initialize({
  android: {
    scopes: ['User.Read'],
    configFileName: 'ms_auth_config',
  },
  ios: {
    scopes: ['User.Read', 'openid', 'profile', 'email', 'offline_access'],
    clientId: '<YOUR_MICROSOFT_CLIENT_ID>',
    redirectUrl: 'msauth.com.omh.auth.sample://auth/',
  },
});

Other methods​

Known limitations"

Due to current limitations to the underlying Microsoft SDK, revoking a token is not supported as of now. Instead an error with the "Method not supported." message will be thrown when calling the revokeAccessToken method.

Interacting with the Microsoft provider follows the same pattern as other providers since they all implement the IAuthModule interface. For a comprehensive list of available methods, refer to the Quick Start guide.

License​