Function Store
  • Home
  • Getting started
    • Introduction
    • Installing a function
    • Reconfiguring a function
    • Uninstalling a function
    • FAQs
  • Reference
    • Requirements
      • Assign Roles
        • User permissions
      • Link a Billing account to your project
      • Enable the APIs
    • Projects
      • How to add a project
      • How to set up a project
    • Functions
      • Benefits
      • Use cases
      • Authentication when installing
      • Runtime configuration
      • Deploying with a ZIP file
    • Policies
      • How to add a Policy
      • How to remove a Policy
    • Authentication
      • Users
      • Roles
      • Permissions
    • Secrets
      • Creating a Secret
      • Using a Secret
      • Changing the value for a Secret
      • Deactivating a Secret
  • developers
    • Overview
    • Getting Started
    • Set up
    • Workspaces
      • Create a workspace
      • Workspace boilerplate
      • Node engines
    • Writing Functions
      • Function Anatomy
      • Configuration file
      • Function Triggers
      • Environment Variables
        • Type "text"
        • Type "number"
        • Type "email"
        • Type "url"
        • Type "json"
        • Type "boolean"
        • Type "select"
        • Type "multiselect"
        • Type "firestoreDocumentPath"
        • Type "firestoreCollectionPath"
        • Type "color"
      • Documentation
    • Push/Update your functions in the cloud
    • Continuous Integration
    • Publish functions in the Marketplace
    • Emulators
      • Initialize emulators in your workspace
      • Environment variables
      • Starting emulators
      • Testing your functions in the emulator
      • Importing existing data into local emulators
        • Exporting data from Cloud Firestore to local emulator
        • Exporting user accounts from Firebase to local emulator
    • Visual Studio Code Extension
      • Installing the extension
      • Extension UI
      • Functions list
      • Creating and editing functions
      • Emulators
      • Extension settings
      • Troubleshooting
        • "Command not found" error when executing a command
  • Billing
    • Understanding Billing
  • Security
    • Security
  • Resources
    • Events and Triggers
    • Best Practices
      • How to log events in functions?
    • Document your Functions
    • Editorial guidelines
    • Our Processes
      • Use Cases Analysis
  • Use cases
    • Custom Stripe Checkout
Powered by GitBook
On this page
  • Overview
  • Start using Secrets

Was this helpful?

  1. Reference

Secrets

Secrets store API keys, passwords, certificates, and other sensitive data.

PreviousPermissionsNextCreating a Secret

Last updated 3 years ago

Was this helpful?

Overview

Passwords, credentials, API keys, and TLS certificates, are sensitive data that need to be stored and accessed in a secured way. With Secrets, you can manage, and use such data within a project in a very simple, fast, and secure way.

A secret is an object that allows you to store data in a secure way. Additionally, it contains other metadata that may include replication locations, tags, and permissions. The encrypted data is stored as an individual object called version.

A version is a structure that stores the value of a secret and it cannot be modified. If you want to modify that value, just add a new version.

Start using Secrets

To start using Secrets, you need to enable the in your project. Once the Secret Manager API is enabled, you can start adding secrets to your project.

To enable the Secret Manager API your account needs serviceusage.services.enable permission.

Let's start creating Secrets! Check the next section and learn how to do it.

👇
Secret Manager API
This video walks you through the steps to use secrets when installing a function.