Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/e2fyi/firebase-admin
cli for firebase admin sdk to set CustomClaims
https://github.com/e2fyi/firebase-admin
cli custom-claims firebase firebase-admin-sdk
Last synced: about 4 hours ago
JSON representation
cli for firebase admin sdk to set CustomClaims
- Host: GitHub
- URL: https://github.com/e2fyi/firebase-admin
- Owner: e2fyi
- License: apache-2.0
- Created: 2018-04-16T07:35:13.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-07T02:03:49.000Z (2 months ago)
- Last Synced: 2024-11-08T18:05:13.225Z (7 days ago)
- Topics: cli, custom-claims, firebase, firebase-admin-sdk
- Language: JavaScript
- Homepage:
- Size: 937 KB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
/firebase
===
[](https://github.com/prettier/prettier)
[](https://david-dm.org/e2fyi/firebase-admin)
[](https://snyk.io/test/github/e2fyi/firebase-admin)
`cli` for [firebase-admin](https://www.npmjs.com/package/firebase-admin).
**Available Features**
- Select project credential (`fb-admin project`)
- List users (`fb-admin users`)
- Update custom claims for user (`fb-admin claims`)
## Installation
```bash
# npm
npm install -g @e2fyi/firebase-admin
# yarn
yarn global add @e2fyi/firebase-admin
```
## Project credentials
The `cli` connects to a firebase project by loading the environment variable `FIREBASE_SERVICE_ACCOUNT` from `.env`. The `.env` can be automatically generate with the `fb-admin project ` command.
**Creating a service account and getting the project credentials**
- Navigate to the `Service Accounts tab` in your project's settings page.
- Click the `Generate New Private Key` button at the bottom of the Firebase Admin SDK section of the Service Accounts tab.
- Download and keep the JSON file in a secure location.
Example
```bash
# setup current project to
# `~/.firebase/firebase_service_account.json`
fb-admin project ~/.firebase/firebase_service_account.json
```
Additional resources:
- https://firebase.google.com/docs/admin/setup#add_firebase_to_your_app
## CLI
```bash
# run cli and see help
fb-admin -h
```
```
usage: fb-admin [-h] [-v] {project,claims,users} ...
cli command to manage custom claims for firebase users.
Optional arguments:
-h, --help Show this help message and exit.
-v, --version Show program's version number and exit.
subcommands:
{project,claims,users}
project Setup credential for a firebase project.
claims Update the custom claims of a firebase user.
users List firebase users.
```
### SUBCOMMAND `PROJECT`
Select a project by providing the path to the service account credentials.
```
usage: fb-admin project [-h] cred
Positional arguments:
cred Path to the JSON credential for firebase project.
Optional arguments:
-h, --help Show this help message and exit.
```
Example
```bash
fb-admin project ~/.firebase/firebase_service_account.json
```
### SUBCOMMAND `CLAIMS`
Update the [customClaims](https://firebase.google.com/docs/auth/admin/custom-claims) of a user.
```
usage: fb-admin claims [-h] [-d DATA] [-f FLAGS] email
Positional arguments:
email ptnet user email
Optional arguments:
-h, --help Show this help message and exit.
-d DATA, --data DATA Set the custom claims with the JSON string. e.g.
'{"admin":1}'
-f FLAGS, --flags FLAGS
Set a flag in custom claims with semicolon-delimited
pairs. e.g. -f admin=1;scope=all;
```
Examples
```bash
# equivalent to -d {"admin": 1, "scope": "all"}
fb-admin claims [email protected] -f admin=1;scope=all;
```
```bash
# equivalent to -f admin=1
fb-admin claims [email protected] -d '{"admin":1}';
```
### SUBCOMMAND `USERS`
List or search users based on email.
```
usage: fb-admin users [-h] [-m MATCH]
Optional arguments:
-h, --help Show this help message and exit.
-m MATCH, --match MATCH
List only users with email matching the provided
minimatch pattern. e.g. *@email.com
```
Examples
```bash
# list all users
fb-admin users
```
```bash
# list all users with email domain "email.com"
fb-admin users -m *@email.com;
```