Skip to main content


React Native OMH Auth - Google (GMS/non-GMS)

NPM downloadsNPM versionLicense

Chat on DiscordFollow on Twitter

Installation​

npm add @openmobilehub/auth-google

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 Google Cloud.
  2. Create an OAuth 2.0 Client ID Android application and specify your Package Name and SHA1 Fingerprint for your app.

Android​

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

android/local.properties
GOOGLE_CLIENT_ID=<YOUR_GOOGLE_CLIENT_ID>

Usage​

Initializing​

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

import GoogleAuthClient from '@openmobilehub/auth-google';

await GoogleAuth.initialize({
  android: {
    scopes: ['openid', 'profile', 'email'],
  },
  ios: {
    scopes: ['openid', 'profile', 'email'],
    clientId: '<YOUR_GOOGLE_CLIENT_ID>',
    redirectUrl: `com.googleusercontent.apps.${
      '<YOUR_GOOGLE_CLIENT_ID>'.split('.')[0]
    }:/oauth2redirect/google`,
  },
});

Other methods​

KNOWN LIMITATIONS

On a GMS enabled device, Google SDK automatically refreshes the access token in the background. Refreshing the access token manually on a GMS enabled device is not supported as of now. Instead the current access token will be returned when calling the refreshAccessToken method.

Interacting with the Google 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​