GraphqlOptions interface

Interface representing GraphQL options.

Signature:

exportinterfaceGraphqlOptions<Variables>

Properties

PropertyTypeDescription
impersonateImpersonateAuthenticated |ImpersonateUnauthenticatedIf set, impersonate a request with given Firebase Auth context and evaluate the auth policies on the operation. If omitted, bypass any defined auth policies.
operationNamestringThe name of the GraphQL operation. Required only ifquery contains multiple operations.
variablesVariablesValues for GraphQL variables provided in this query or mutation.

GraphqlOptions.impersonate

If set, impersonate a request with given Firebase Auth context and evaluate the auth policies on the operation. If omitted, bypass any defined auth policies.

Signature:

impersonate?:ImpersonateAuthenticated|ImpersonateUnauthenticated;

GraphqlOptions.operationName

The name of the GraphQL operation. Required only ifquery contains multiple operations.

Signature:

operationName?:string;

GraphqlOptions.variables

Values for GraphQL variables provided in this query or mutation.

Signature:

variables?:Variables;

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-03-05 UTC.