# Firebase Admin connector

Source: /docs/connectors/firebase-admin.md

Use this as an implementation starting point: adapt the worked example to the requested dataset and the source documentation. See [Custom API](/docs/connectors/custom-api) for the shared SDK pattern and document-upload workflow.

## What this connector is for [#what-this-connector-is-for]

Firebase-backed user management, messaging, and project services.

Use this guide to choose the resources and row meanings for a Vortexify source integration. Connection ownership belongs to a connector; each dataset gets its own sync, configuration, and extraction behavior.

## Data and tables you can pull [#data-and-tables-you-can-pull]

The following table families are a starting point for source selection. They describe possible datasets to implement using the [vendor reference](https://firebase.google.com/docs/auth/admin/manage-users), not a guarantee that the example implements every table. Actual availability depends on the product edition, deployment, account permissions, and API/schema version.

| Suggested table | One row represents |
| --- | --- |
| `auth_users` | a auth user |
| `firestore_documents` | a firestore document |
| `realtime_database_nodes` | a realtime database node |

### Relationships and extraction considerations [#relationships-and-extraction-considerations]

These are proposed dataset names, not a universal schema guaranteed by the vendor. Preserve source object IDs and relationship references, and split nested child collections into separate tables when appropriate. Choose the concrete endpoint/report and row meaning from the vendor reference before implementing a sync.

## Connecting to Firebase Admin [#connecting-to-firebase-admin]

Use an authorized Firebase service account. The example selects Authentication, reads users in pages, and releases its uniquely named Admin SDK app afterward. Other Firebase services need their own clients and read operations.

The example's `config` keys show the connection fields it uses. Store credentials in platform configuration marked as secret; host/project/database identifiers are ordinary connection settings. Environment and network access must match the selected source.

### requirements.in [#requirementsin]

Declare these packages in the resource's `requirements.in`. Use the published `vortexify` package for the SDK and the source-specific driver/client shown below. Choose compatible dependency versions for your runtime; the [connector and sync reference](/docs/reference/python/connectors-and-syncs) explains where each file belongs.

```text
vortexify==0.1.1
pandas>=2,<3
firebase-admin
```

Use an authorized Firebase service account. The example selects Authentication, reads users in pages, and releases its uniquely named Admin SDK app afterward. Other Firebase services need their own clients and read operations.

## Worked example: Authentication users [#worked-example-authentication-users]

This source-read pattern shows how to shape the selected resource into DataFrames. Use it inside the dataset sync, retaining shared connection ownership in the connector. Its scope is the named resource and filters; adapt the projection, batching, and preview to the requested table.

### Source read [#source-read]

```python
from uuid import uuid4
import firebase_admin
from firebase_admin import auth, credentials
import pandas as pd


def read_batches(service_account_info):
    app = firebase_admin.initialize_app(
        credentials.Certificate(service_account_info), name=f"read-{uuid4().hex}"
    )
    try:
        page = auth.list_users(max_results=100, app=app)
        while page is not None:
            rows = [
                {"uid": user.uid, "email": user.email, "disabled": user.disabled}
                for user in page.users
            ]
            if rows:
                yield pd.DataFrame(rows)
            page = page.get_next_page()
    finally:
        firebase_admin.delete_app(app)
```

### What to adapt [#what-to-adapt]

This explicitly selects Firebase Authentication, not every Firebase service. A unique named app avoids reusing global default-app state. A preview creates its own app and reads only the first page. Firestore and Realtime Database have different extraction contracts.

Use the [custom API SDK starting point](/docs/connectors/custom-api#worked-example-cursor-paginated-json-records) to connect the read operation to `Connector` and `Sync`. For a source with its own driver, retain that client in `Connector.client()` and replace the HTTP request with the driver read. An `extract(*, avg_row_size_bytes=None)` implementation yields bounded DataFrames. An independent `preview()` uses a fresh connector and a small read; it must not call extraction or advance real state.

Choose explicit output columns and stable IDs for the requested table. The examples use `json_normalize` where useful to illustrate row shaping; nested arrays still need deliberate child tables and a stable declared output schema. A first-page sample is useful for development, while a full sync must follow all relevant continuation/parent-resource paths. Design incremental watermarks, update/deletion behavior, and rate-limit handling for the actual source before enabling incremental mode.

The purpose is to give a coding agent a concrete pattern to adapt, including for similar sources. These snippets are examples rather than a claim of complete vendor coverage. Check the [source operation reference](https://firebase.google.com/docs/auth/admin/manage-users#list_all_users) and representative responses before running with a customer's account; live vendor execution has not been verified here.

## Sources and further reading [#sources-and-further-reading]

- [Vendor connection and resource reference](https://firebase.google.com/docs/auth/admin/manage-users#list_all_users) — The interface/access prerequisites underlying this connection path; follow the selected resource's documentation for fields, queries, and pagination.
- [Vortexify connectors and syncs](/docs/reference/python/connectors-and-syncs) — Connector ownership, schemas, preview isolation, extraction, and checkpoint contracts.
- [Vortexify CLI workflow](/docs/reference/cli/overview) — Registering resources, committing source, and providing credential configuration.