Categoryfirebase.google.com/go/v4
modulepackage
4.15.1
Repository: https://github.com/firebase/firebase-admin-go.git
Documentation: pkg.go.dev

# README

Build Status GoDoc Go Report Card

Firebase Admin Go SDK

Table of Contents

Overview

Firebase provides the tools and infrastructure you need to develop apps, grow your user base, and earn money. The Firebase Admin Go SDK enables access to Firebase services from privileged environments (such as servers or cloud) in Go. Currently this SDK provides Firebase custom authentication support.

For more information, visit the Firebase Admin SDK setup guide.

Installation

The Firebase Admin Go SDK can be installed using the go get utility:

# Install the latest version:
go get firebase.google.com/go/v4@latest

# Or install a specific version:
go get firebase.google.com/go/[email protected]

Contributing

Please refer to the CONTRIBUTING page for more information about how you can contribute to this project. We welcome bug reports, feature requests, code review feedback, and also pull requests.

Supported Go Versions

The Admin Go SDK is compatible with at least the three most recent, major Go releases. We currently support Go v1.21 and higher. Continuous integration system tests the code on Go v1.21 through v1.23.

Documentation

License and Terms

Firebase Admin Go SDK is licensed under the Apache License, version 2.0.

Your use of Firebase is governed by the Terms of Service for Firebase Services.

# Packages

Package appcheck provides functionality for verifying App Check tokens.
Package auth contains functions for minting custom authentication tokens, verifying Firebase ID tokens, and managing users in a Firebase project.
Package db contains functions for accessing the Firebase Realtime Database.
Package errorutils provides functions for checking and handling error conditions.
Package iid contains functions for deleting instance IDs from Firebase projects.
No description provided by the author
Package messaging contains functions for sending messages and managing device subscriptions with Firebase Cloud Messaging (FCM).
No description provided by the author
Package storage provides functions for accessing Google Cloud Storge buckets.

# Functions

NewApp creates a new App from the provided config and client options.

# Constants

Version of the Firebase Go Admin SDK.

# Structs

An App holds configuration and state common to all Firebase services that are exposed from the SDK.
Config represents the configuration used to initialize an App.