Merge pull request #1145 from CaptainDingle/getCustomClaims

Added option to retrieve Firebase custom claims - resolves #1008

Author: EddyVerbruggen

docs/AUTHENTICATION.md

@@ -649,6 +649,10 @@ To solve, you will want to pass in the appropriate iOS controller of the active
 If you want to authenticate your user from your backend server you can obtain
 a Firebase auth token for the currently logged in user.
 
+You can choose to get just the token itself or the token plus any custom claims you may have previously set via the Firebase Admin SDK as outlined [here](https://firebase.google.com/docs/auth/admin/custom-claims):
+
+Just token:
+
 ```js
   firebase.getAuthToken({
     // default false, not recommended to set to true by Firebase but exposed for {N} devs nonetheless :)
@@ -663,6 +667,29 @@ a Firebase auth token for the currently logged in user.
   );
 ```
 
+Token with custom claims:
+
+```js
+  firebase.getAuthToken({
+    // default false, not recommended to set to true by Firebase but exposed for {N} devs nonetheless :)
+    forceRefresh: false,
+    // set to true to also retrieve your custom claims
+    withClaims: true
+  }).then(
+      function (result) {
+        // for both platforms
+        console.log("Auth token retrieved: " + result.token);
+        // Android only
+        console.log("Specific custom claim retrieved: " + result.claims.get('yourClaimKey'));
+        // iOS only
+        console.log("Specific custom claim retrieved: " + result.claims.objectForKey('yourClaimKey'));
+      },
+      function (errorMessage) {
+        console.log("Auth result retrieval error: " + errorMessage);
+      }
+  );
+```
+
 ### logout
 Shouldn't be more complicated than:
 

src/firebase.android.ts

@@ -704,7 +704,18 @@ firebase.getAuthToken = arg => {
       if (user !== null) {
         const onSuccessListener = new gmsTasks.OnSuccessListener({
           onSuccess: getTokenResult => {
-            resolve(getTokenResult.getToken());
+            if (arg.withClaims) {
+               /* get token and custom claims previously set via the Firebase Admin SDK. */
+              resolve(
+                  {
+                      token: getTokenResult.getToken(),
+                      claims: getTokenResult.getClaims()
+             }
+              );
+          } else {
+             /* get just token without custom claims */
+              resolve(getTokenResult.getToken());
+          }
           }
         });
 

src/firebase.d.ts

@@ -202,6 +202,8 @@ export interface GetAuthTokenOptions {
    * Default false.
    */
   forceRefresh?: boolean;
+  /* Set this to true if you want any custom claims returned that you previously set via the Firebase Admin SDK. */
+  withClaims?: boolean;
 }
 
 export interface Provider {
@@ -873,7 +875,7 @@ export function reauthenticate(options: ReauthenticateOptions): Promise<any>;
 
 export function reloadUser(): Promise<void>;
 
-export function getAuthToken(option: GetAuthTokenOptions): Promise<string>;
+export function getAuthToken(option: GetAuthTokenOptions): Promise<any>;
 
 export function logout(): Promise<any>;
 

src/firebase.ios.ts

@@ -680,7 +680,13 @@ firebase.getAuthToken = arg => {
             resolve(token);
           }
         };
-        user.getIDTokenForcingRefreshCompletion(arg.forceRefresh, onCompletion);
+        /* get token and custom claims previously set via the Firebase Admin SDK. */
+        if(arg.withClaims) {
+          user.getIDTokenResultForcingRefreshCompletion(arg.forceRefresh, onCompletion);
+      } else {
+        /* get just token without custom claims */
+          user.getIDTokenForcingRefreshCompletion(arg.forceRefresh, onCompletion);
+      }
       } else {
         reject("Log in first");
       }