admin.auth().setCustomUserClaims "is not a function"

Question

In a Firebase Cloud Function running Express, I am attempting to set custom user claims when a client posts a token to a setCustomClaims route. When I call admin.auth().setCustomUserClaims(uid, {admin: true}) within that route, I get an error saying this is "not a function."

My authentication provider is the email/password provider via Firebase authentication (i.e. I am not creating custom tokens).

Do I have to be creating custom tokens to set custom user claims?

Here is my cloud function code:

const functions = require('firebase-functions');
const admin = require("firebase-admin");
import express from "express"

admin.initializeApp(functions.config().firebase);
const app = express()

app.post('/setCustomClaims', (req, res) => {
    uid = "some-uid"
    admin.auth().setCustomUserClaims(uid, {admin:true}).then(()=> {
        res.end(JSON.stringify( { status: 'success' } ) );
    })
});

export let api = functions.https.onRequest((request, response) => {
  if (!request.path) {
    request.url = `/${request.url}` // prepend '/' to keep query params if any
  }
  return app(request, response)
})

does it say that `setCustomUserClaims` is not a function? or by any chance the `res.end(` typo is also in your real code? — mbehzad, Oct 05 '17 at 14:12
The exact error is: TypeError: admin.auth(...).setCustomUserClaims is not a function. — sketchedin, Oct 05 '17 at 14:35
The `setCustomUserClaims` was introduced very recently in [version 5.3 of the Firebase Admin SDK for Node.js](https://firebase.google.com/support/releases#september_27_2017). Can you check what version of `firebase-admin` you are on? — Frank van Puffelen, Oct 05 '17 at 14:42
Ah! I am running 5.2.1. I'm going to update now. Thank you, Frank. — sketchedin, Oct 05 '17 at 15:02
Upgrading to the latest Firebase Admin SDK solved this problem. — sketchedin, Oct 05 '17 at 19:41
In "firebase-admin": "^8.12.1" it's not working, I encountered the same issue! @sketchedin — Kavin Raju S, Jun 03 '20 at 18:13

score 0 · Answer 1 · edited Nov 05 '17 at 06:43

0

npm install firebase-admin@latest --save

firebase-admin@5.4.3 work, good luck for fun app.

Note: client needs this code

// Force token refresh. The token claims will contain the additional claims.
firebase.auth().currentUser.getIdToken(true);

edited Nov 05 '17 at 06:43

SilverNak

3,283
4
28
44

answered Nov 05 '17 at 06:15

Diep Gepa

515
5
5

1

This did not solve my issue. I am using the latest code and still no luck – Charklewis Oct 13 '19 at 15:31
1

In "firebase-admin": "^8.12.1" it's not working, I encountered the same issue! @Charklewis – Kavin Raju S Jun 03 '20 at 18:14

score -2 · Answer 2 · answered Oct 05 '17 at 14:25

In the new SDKs, you no longer instantiate a database references via new Firebase. Instead, you will initialize the SDK via firebase.initializeApp():

BEFORE

var ref = new Firebase("https://databaseName.firebaseio.com");

AFTER

 // See https://firebase.google.com/docs/web/setup#project_setup for how to

 // auto-generate this config
 var config = {
 apiKey: "apiKey",
 authDomain: "projectId.firebaseapp.com",
 databaseURL: "https://databaseName.firebaseio.com"
 };

 firebase.initializeApp(config);

 var rootRef = firebase.database().ref();>

I have found same issue on the stackoverflow, check this: firebase.database is not a function

I am using _admin.initializeApp(functions.config().firebase);_ to initialize the firebase reference. Does this still work? — sketchedin, Oct 05 '17 at 14:37

admin.auth().setCustomUserClaims "is not a function"

2 Answers2