Skip to main content

@swamp/gcp/firebase

v2026.04.23.1

Google Cloud firebase infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

gcpgoogle-cloudfirebasecloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/firebase

@swamp/gcp/firebase/androidappsv2026.04.23.1androidapps.ts

Global Arguments

ArgumentTypeDescription
apiKeyId?stringThe globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the `AndroidApp`. Be aware that this value is the UID of the API key, _not_ the [`keyString`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key. The `keyString` is the value that can be found in the App's [configuration artifact](../../rest/v1beta1/projects.androidApps/getConfig). If `api_key_id` is not set in requests to [`androidApp
displayName?stringThe user-assigned display name for the `AndroidApp`.
name?stringThe resource name of the AndroidApp, in the format: projects/ PROJECT_IDENTIFIER/androidApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`.
packageName?stringImmutable. The canonical package name of the Android app as would appear in the Google Play Developer Console.
sha1Hashes?arrayThe SHA1 certificate hashes for the AndroidApp.
sha256Hashes?arrayThe SHA256 certificate hashes for the AndroidApp.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a androidApps
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a androidApps
ArgumentTypeDescription
identifierstringThe name of the androidApps
updateUpdate androidApps attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the androidApps
ArgumentTypeDescription
identifierstringThe name of the androidApps
syncSync androidApps state from GCP
get_configget config
undeleteundelete
ArgumentTypeDescription
etag?any
validateOnly?any

Resources

state(infinite)— Details of a Firebase App for Android.
@swamp/gcp/firebase/androidapps-shav2026.04.23.1androidapps_sha.ts

Global Arguments

ArgumentTypeDescription
certType?enumThe type of SHA certificate encoded in the hash.
name?stringThe resource name of the ShaCertificate for the AndroidApp, in the format: projects/PROJECT_IDENTIFIER/androidApps/APP_ID/sha/SHA_HASH * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any res
shaHash?stringThe certificate hash for the `AndroidApp`.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a sha
getGet a sha
ArgumentTypeDescription
identifierstringThe name of the sha
deleteDelete the sha
ArgumentTypeDescription
identifierstringThe name of the sha
syncSync sha state from GCP

Resources

state(infinite)— A SHA-1 or SHA-256 certificate associated with the AndroidApp.
@swamp/gcp/firebase/availablelocationsv2026.04.23.1availablelocations.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
getGet a availableLocations
ArgumentTypeDescription
identifierstringThe name of the availableLocations
syncSync availableLocations state from GCP

Resources

state(infinite)— **DEPRECATED.** _This Location is no longer used to determine Firebase resour...
@swamp/gcp/firebase/availableprojectsv2026.04.23.1availableprojects.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
getGet a availableProjects
ArgumentTypeDescription
identifierstringThe name of the availableProjects
syncSync availableProjects state from GCP

Resources

state(infinite)— A reference to a Google Cloud `Project`.
@swamp/gcp/firebase/iosappsv2026.04.23.1iosapps.ts

Global Arguments

ArgumentTypeDescription
apiKeyId?stringThe globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the `IosApp`. Be aware that this value is the UID of the API key, _not_ the [`keyString`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key. The `keyString` is the value that can be found in the App's [configuration artifact](../../rest/v1beta1/projects.iosApps/getConfig). If `api_key_id` is not set in requests to [`iosApps.Create`](.
appStoreId?stringThe automatically generated Apple ID assigned to the iOS app by Apple in the iOS App Store.
bundleId?stringImmutable. The canonical bundle ID of the iOS app as it would appear in the iOS AppStore.
displayName?stringThe user-assigned display name for the `IosApp`.
name?stringThe resource name of the IosApp, in the format: projects/PROJECT_IDENTIFIER /iosApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_I
teamId?stringThe Apple Developer Team ID associated with the App in the App Store.
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a iosApps
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a iosApps
ArgumentTypeDescription
identifierstringThe name of the iosApps
updateUpdate iosApps attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the iosApps
ArgumentTypeDescription
identifierstringThe name of the iosApps
syncSync iosApps state from GCP
get_configget config
undeleteundelete
ArgumentTypeDescription
etag?any
validateOnly?any

Resources

state(infinite)— Details of a Firebase App for iOS.
@swamp/gcp/firebase/projectsv2026.04.23.1projects.ts

Global Arguments

ArgumentTypeDescription
annotations?recordA set of user-defined annotations for the FirebaseProject. Learn more about annotations in Google's [AIP-128 standard](https://google.aip.dev/128#annotations). These annotations are intended solely for developers and client-side tools. Firebase services will not mutate this annotations set.
displayName?stringThe user-assigned display name of the Project.
etag?stringThis checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about `etag` in Google's [AIP-154 standard](https://google.aip.dev/154#declarative-friendly-resources). This etag is strongly validated.
name?stringThe resource name of the Project, in the format: projects/PROJECT_IDENTIFIER PROJECT_IDENTIFIER: the Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`.
projectId?stringOutput only. Immutable. A user-assigned unique identifier for the Project. This identifier may appear in URLs or names for some Firebase resources associated with the Project, but it should generally be treated as a convenience alias to reference the Project.
projectNumber?stringOutput only. Immutable. The globally unique, Google-assigned canonical identifier for the Project. Use this identifier when configuring integrations and/or making API calls to Firebase or third-party services.
state?enumOutput only. The lifecycle state of the Project.
getGet a projects
ArgumentTypeDescription
identifierstringThe name of the projects
updateUpdate projects attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the projects
ArgumentTypeDescription
identifierstringThe name of the projects
syncSync projects state from GCP
add_firebaseadd firebase
ArgumentTypeDescription
locationId?any
add_google_analyticsadd google analytics
ArgumentTypeDescription
analyticsAccountId?any
analyticsPropertyId?any
get_admin_sdk_configget admin sdk config
get_analytics_detailsget analytics details
search_appssearch apps

Resources

state(infinite)— A `FirebaseProject` is the top-level Firebase entity. It is the container for...
@swamp/gcp/firebase/webappsv2026.04.23.1webapps.ts

Global Arguments

ArgumentTypeDescription
apiKeyId?stringThe globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the `WebApp`. Be aware that this value is the UID of the API key, _not_ the [`keyString`](https://cloud.google.com/api-keys/docs/reference/rest/v2/projects.locations.keys#Key.FIELDS.key_string) of the API key. The `keyString` is the value that can be found in the App's [configuration artifact](../../rest/v1beta1/projects.webApps/getConfig). If `api_key_id` is not set in requests to [`webApps.Create`](.
appUrls?arrayThe URLs where the `WebApp` is hosted.
displayName?stringThe user-assigned display name for the `WebApp`.
name?stringThe resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number) ***(recommended)*** or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id). Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). Note that the value for PROJECT_IDENTIFIER in any response body will be the `ProjectId`. * APP_I
location?stringThe location for this resource (e.g., 'us', 'us-central1', 'europe-west1')
createCreate a webApps
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after creation (default: true)
getGet a webApps
ArgumentTypeDescription
identifierstringThe name of the webApps
updateUpdate webApps attributes
ArgumentTypeDescription
waitForReady?booleanWait for the resource to reach a ready state after update (default: true)
deleteDelete the webApps
ArgumentTypeDescription
identifierstringThe name of the webApps
syncSync webApps state from GCP
get_configget config
undeleteundelete
ArgumentTypeDescription
etag?any
validateOnly?any

Resources

state(infinite)— Details of a Firebase App for the web.