FireCMS Cloud

Invite a new user to a FireCMS project. Sends an invitation email. Admin-only. If the email already belongs to a user of the project, their roles are replaced by these.

Add FireCMS's access rule to a project's Firestore and Storage security rules. Requires admin. FireCMS Cloud reads the customer's Firestore from the browser using the signed-in user's own token, so it needs a rule granting access to users carrying the `fireCMSUser` claim: match /{document=**} { allow read, write: if request.auth.token.fireCMSUser; } Without it the CMS shows "Missing Firestore Security Rules" and no collection opens, although this server keeps working: it reads through the backend's service account, which bypasses security rules. The rule is injected into the existing ruleset rather than replacing it, and a project that already has it is left alone, so it is safe to run again. Connecting a project applies it already; this repairs projects connected earlier, or where that step failed.

Connect an existing Firebase project to FireCMS Cloud. It creates a delegated service account in the project with the permissions FireCMS needs, registers the signed-in user as an admin, creates the FireCMS project on the free plan, and by default adds FireCMS's access rule to the project's Firestore and Storage security rules. Firebase, Firestore and Firebase Authentication must already be enabled on the project. Authentication cannot be enabled through any API: it is switched on once in the Firebase console. Fails if the project is already connected.

Count the total number of documents in a Firestore collection.

Create a new document in a Firestore collection. Provide the field values as a JSON object.

Create the FireCMS web app inside the client's Firebase project, or reuse the one already there. Connecting a project normally does this; this repairs a project where that step failed. Requires admin.

Delete a collection schema from FireCMS. This removes the collection configuration from the CMS — it does NOT delete the underlying Firestore data. The collection will simply no longer appear in the FireCMS UI.

Delete a document from Firestore. This action is permanent.

Remove a property from a collection schema. This removes the field definition from the CMS configuration — it does NOT delete the field from existing Firestore documents.

Create the default Firestore database in a Google Cloud project, in the given location. The location is permanent and cannot be changed later.

Enable the Google Cloud APIs that FireCMS requires on a project (reported as `apisEnabled` in its setup status). Safe to run more than once.

Export documents from a Firestore collection as JSON. Useful for data backups, analysis, or migration. For large collections, use the limit parameter.

Get the currently authenticated FireCMS user

Sign in to FireCMS Cloud. Opens a browser window for Google OAuth authentication. Required before using any other tools.

Sign out of FireCMS Cloud. Revokes the current session.

Generate a new FireCMS collection schema using AI. Provide a natural language description of the collection you want (e.g., "A blog with posts that have title, body, author, tags, and a featured image"). Returns a complete FireCMS collection configuration.

Get the full schema definition for a specific collection, including all properties, validation rules, display configuration, and subcollection definitions.

Get a specific document by its collection path and ID. Returns all fields of the document.

Get the full configuration for a FireCMS project, including: - Project name, logo, and brand colors (primary/secondary) - Subscription plan and trial status - Feature toggles (text search, entity history, App Check) - Default locale settings - Customization revision info

Get the detailed FireCMS readiness status of a single Google Cloud project: whether Firebase, Firestore, Storage, Auth and the required APIs are enabled, and so what is still missing before it can be connected.

List all Firestore root-level collections in a FireCMS project — the paths that can be turned into CMS collections. Read live from Firestore, so collections created moments ago are included.

Bulk import documents into a Firestore collection, for seeding data, migrations or restoring a backup. Each document can specify an ID; without one, Firestore generates it. By default a document with an existing ID is overwritten; with merge: true its fields are merged instead. At most 500 documents per call.

Infer collections from the existing Firestore data at the given paths, and save them to the project. Requires admin. For each path the backend samples documents, infers the property types, then uses an LLM to pick display names, a singular name, an icon, a navigation group and field widgets. Paths already mapped to a collection, and paths with no documents, are skipped.

List all persisted collection schemas for a FireCMS project. Returns the collection configurations (name, path, properties, etc.) that define how data is displayed and edited in the CMS.

List the Firestore databases of a project. Only needed for projects using more than the '(default)' database — the resulting database IDs can be passed to the other introspection and document tools.

List documents from a Firestore collection, with optional filters, ordering and a limit.

List the Google Cloud / Firebase projects the signed-in user can access, and whether each one is ready to be connected to FireCMS Cloud. Each entry reports: - `fireCMSProject`: true if it is already connected to FireCMS Cloud - `cloudProjectConfigurationStatus.firebaseEnabled` / `firestoreEnabled` / `apisEnabled` / `authEnabled`: what connecting requires Connecting needs Firebase, Firestore and Firebase Authentication enabled.

List the locations available for a new Firestore database, as location IDs such as 'eur3' or 'us-central'.

List all FireCMS Cloud projects accessible by the authenticated user

List the subcollections of a specific document, with their full paths: nested data that can be turned into CMS collections.

List all users that have access to a FireCMS project, including their roles (admin, editor, viewer)

Modify an existing FireCMS collection schema using AI. Describe the changes you want (e.g., "Add a priority enum with low/medium/high" or "Make title required with max 100 chars"). Returns the updated schema and a list of operations performed.

Read a sample of real documents from a Firestore path and infer a FireCMS collection schema from them, without saving anything. Works for any path, subcollections included. Inference is structural only: it derives data types, enum candidates and validation from the sampled values. The result is a complete collection schema that can be edited and saved as it is.

Remove a user from a FireCMS project, revoking their access. Admin-only.

Create or fully replace a collection schema. This defines how a Firestore collection is displayed and edited in FireCMS. Requires at minimum: id, path, and name. Example schema: { "id": "products", "path": "products", "name": "Products", "singularName": "Product", "icon": "ShoppingCart", "description": "Product catalog", "group": "Shop", "properties": { "name": { "dataType": "string", "name": "Name", "validation": { "required": true } }, "price": { "dataType": "number", "name": "Price", "validation": { "required": true, "min": 0 } }, "status": { "dataType": "string", "name": "Status", "enumValues": [ { "id": "draft", "label": "Draft" }, { "id": "published", "label": "Published" } ]} }, "propertiesOrder": ["name", "price", "status"] }

Add or update a single property in a collection schema, leaving the other properties as they are. A new property is added at the end of the display order. Example property: { "dataType": "string", "name": "Description", "description": "Product description", "multiline": true, "validation": { "required": true, "max": 500 } }

Discover every Firestore root collection in the project that is not yet mapped to a collection, infer a collection schema for each (display names and widgets picked by an LLM), and save them all. Requires admin. Covers every database of the project. Collections that already exist are left alone, so it is safe to run again later to pick up new Firestore collections. Can take a while on large projects.

Enable or disable entity history tracking (audit log of document changes) for a project.

Enable or disable the local text search feature for a project.

Partially update an existing collection schema. Only the top-level fields given are changed (merged with the existing schema): for example the name, group, display settings or properties.

Change the default locale for the CMS (affects date formatting, etc.).

Update fields of an existing document. Only the specified fields are modified (partial update / merge).

Update the primary and/or secondary brand colors for the CMS UI. Colors should be hex values (e.g., '#0070F4').

Update the display name of a FireCMS project.

Update the roles of an existing user in a FireCMS project. Admin-only.