Method: availableProjects.list

Returns a list of Google Cloud Platform (GCP) Projects that are available to have Firebase resources added to them.

A GCP Project will only be returned if:

  1. The caller has sufficient Google IAM permissions to call projects.addFirebase.

  2. The GCP Project is not already a FirebaseProject.

  3. The GCP Project is not in an Organization which has policies that prevent Firebase resources from being added.

HTTP request

GET https://firebase.googleapis.com/v1beta1/availableProjects

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
pageToken

string

Token returned from a previous call to availableProjects.list indicating where in the set of GCP Projects to resume listing.

pageSize

number

The maximum number of GCP Projects to return in the response.

The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.

This value cannot be negative.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "projectInfo": [
    {
      object(ProjectInfo)
    }
  ],
  "nextPageToken": string
}
Fields
projectInfo[]

object(ProjectInfo)

The list of GCP Projects which can have Firebase resources added to them.

nextPageToken

string

If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results.

This token can be used in a subsequent calls to availableProjects.list to find the next group of GCP Projects.

Page tokens are short-lived and should not be persisted.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

For more information, see the Authentication Overview.

ProjectInfo

A reference to a Google Cloud Platform (GCP) Project.

JSON representation
{
  "project": string,
  "displayName": string,
  "locationId": string
}
Fields
project

string

The resource name of the GCP Project to which Firebase resources can be added, for example:

projects/my-project-123

displayName

string

The user-assigned display name of the GCP Project, for example:

My App

locationId

string

The default resource location of other Firebase resources (such as Cloud Firestore).
Not all projects will have this field populated. If it is not populated, it means that the project is not yet associated with any region. Consequently, a call to projects.addFirebase must provide a location in this case.
For examples, see https://cloud.google.com/appengine/docs/locations.

Try it!

Send feedback about...

Need help? Visit our support page.