Method: projects.locations.services.connectors.impersonateQuery

Impersonate a query defined on a Firebase SQL Connect connector.

It grants the admin SDK access to queries defined in the given connector. The caller can choose to impersonate a particular Firebase Auth user, or skip @auth completely.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the connector to find the predefined query/mutation, in the format:

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

Request body

The request body contains data with the following structure:

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

string

Required. The name of the GraphQL operation name. Required because all Connector operations must be named. 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.connectors.impersonateQuery

For more information, see the IAM documentation.