Method: projects.locations.services.executeGraphql

Execute any GraphQL query or mutation against the Firebase SQL Connect's generated GraphQL schema. Grants full read and write access to the connected data sources.

Note: Use introspection query to explore the generated GraphQL schema.

HTTP request

POST https://firebasedataconnect.googleapis.com/v1/{name=projects/*/locations/*/services/*}:executeGraphql

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The relative resource name of Firebase SQL Connect service, in the format:

projects/{project}/locations/{location}/services/{service}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "query": string,
  "operationName": string,
  "variables": {
    object
  },
  "extensions": {
    object (GraphqlRequestExtensions)
  }
}
Fields
query

string

Required. The GraphQL query document source.
operationName

string

Optional. The name of the GraphQL operation name. Required only if query contains multiple operations. See https://graphql.org/learn/queries/#operation-name.
variables

object (Struct format)

Optional. Values for GraphQL variables provided in this request.
extensions

object (GraphqlRequestExtensions)

Optional. Additional GraphQL request information.

Response body

If successful, the response body contains an instance of GraphqlResponse.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the OAuth 2.0 Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • firebasedataconnect.services.executeGraphql

For more information, see the IAM documentation.