GitXplorerGitXplorer
t

FirebaseAuthenticationGoogleAppsScript

public
6 stars
4 forks
5 issues

Commits

List of commits on branch main.
Verified
bad1ccb3b25a48082f8f6e1fa5503937b0278a8b

Merge pull request #11 from n0mer/patch-1

ttricknotes committed 4 years ago
Verified
86688fe496f6f2449562310c9788236a6889b55a

fix typo

nn0mer committed 4 years ago
Verified
381ae57fca1d86f0090cb9d5b86202d54c3a43e6

Merge remote-tracking branch 'origin/master' into main

ttricknotes committed 4 years ago
Verified
e9fdffa51117ceb3523964cf0ff734b05c492f95

Migrate default branch to "main"

ttricknotes committed 4 years ago
Verified
9f75fa9b199481aeb5b3b401eaac2018381d356a

Merge pull request #10 from tricknotes/update

ttricknotes committed 4 years ago
Verified
1f62a3dfcf82f0c9ed3b09b816a0cae751164442

update @types/google-apps-script

ttricknotes committed 4 years ago

README

The README file for this repository.

Firebase Authentication for Google Apps Scripts

This library is under development, so breaking change may be landed in frequently.

This library focuses to support the APIs on https://firebase.google.com/docs/reference/rest/auth like firebase-admin-node interface.

Installation

Please enter M1lZwUjHOhi_bxE4didbbG5jiNITGdNhd as GAS library for your project.

Usage

Configurating Firebase Authentication instance from your script.

Let's start creating instance with the following code:

const auth = FirebaseAuthentication.getAuth(email, key, projectId);

You need to set arguments as below:

  • email … client email address
  • key … private key
  • projectId … your project id

Configuration Template

Here's a quick template to get you started (by replacing email and key with your values):

const email = 'projectname-12345@appspot.gserviceaccount.com';
const key = '-----BEGIN PRIVATE KEY-----\nPrivateKeyLine1\nPrivateKeyLine2\nPrivateKeyLineN\n-----END PRIVATE KEY-----';
const projectId = 'projectname-12345'
const auth = FirebaseAuthentication.getAuth(email, key, projectId);

Find User

// List users
auth.getUsers();

// Get an user
auth.getUserByEmail(email);
auth.getUserByPhoneNumber(phoneNumber);
auth.getUserByUid(uid);

Creating User

// This value must include a key that identify user, like `email`.
const user = {...};

// To create an user.
auth.createUser(user);

// To create some users.
auth.createUsers([user]);

Updating User

const user = {...};

auth.updateUser(user);

Deleting User

// User id to identify on Firebase Authentication
const localId = '...';

auth.deleteUser(localId);
auth.deleteUsers([localId], true);

For TypeScript Users

Please install FirebaseAuthenticationGoogleAppsScript as a node module to import type declaration.

$ yarn install --dev FirebaseAuthenticationGoogleAppsScript
# Or, $ npm install --save-dev FirebaseAuthenticationGoogleAppsScript

Then, add the following import sentence into your module.

import { FirebaseAuthentication } from 'firebase-authentication-google-apps-script';

const auth = FirebaseAuthentication.getAuth(email, key, projectId);

Development

Setup

  1. Create your own script.
$ yarn run setup
  1. Connect script to your Cloud Platform Project.

See for details: https://developers.google.com/apps-script/guides/cloud-platform-projects#switching_to_a_different_standard_gcp_project

  1. Create OAuth Client and login with your Cloud Platform Credential.

See for details: https://developers.google.com/apps-script/guides/cloud-platform-projects#creating_oauth_credentials

Test

$ yarn run test

TODO

This library doesn't support some APIs and requires developer friendly futures. See issues for details.

References

This project is inspired by the following libraries: