Authenticate using API key with auth manager

To let your agents authenticate to external tools like Google Maps or Weather APIs, configure outbound authentication using API key auth providers in Agent Identity auth manager.

API key auth providers manage your cryptographic keys for you. This capability removes the need to hardcode keys in your agent's code or manage them manually.

API key workflow

API key auth providers use the agent's identity and don't require user consent. Google takes measures to help secure the API key during storage. When you use the Agent Development Kit (ADK), it automatically retrieves and injects the API key into the tool invocation headers.

Before you begin

  1. Verify that you have chosen the correct authentication method.

  2. Enable the Agent Identity Connector API.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the API

  3. Create and deploy an agent.

  4. Obtain an API key from the third-party service that you want to connect to.

  5. Verify that you have the roles required to complete this task.

Required roles

To get the permissions that you need to create and use an API key auth provider, ask your administrator to grant you the following IAM roles on the project:

For more information about granting roles, see Manage access to projects, folders, and organizations.

These predefined roles contain the permissions required to create and use an API key auth provider. To see the exact permissions that are required, expand the Required permissions section:

Required permissions

The following permissions are required to create and use an API key auth provider:

  • To create auth providers: iamconnectors.connectors.create
  • To use auth providers:
    • iamconnectors.connectors.retrieveCredentials
    • aiplatform.endpoints.predict
    • aiplatform.sessions.create

You might also be able to get these permissions with custom roles or other predefined roles.

Obtain an API key from the third-party service

Before you create an auth provider, obtain an API key from the third-party service that you want your agent to connect to.

If you are connecting to a third-party service outside of Google Cloud, obtain the API key from that service's developer portal and skip the steps in this section.

If you are connecting to Google Cloud services (such as Cloud Translation or Google Maps), you can generate and configure an API key by performing the following steps:

  1. In the Google Cloud console, enable the required API services for your project:

    1. In the Google Cloud console, go to the APIs & Services >Library page.

      Go to APIs & Services >Library

    2. Search for and enable the APIs that your agent uses, such as the Cloud Translation API or the Google Maps Weather API.
    3. Copy your generated API key string.

  2. Configure your API key:

    1. In the Google Cloud console, go to the APIs & Services >Credentials page.

      Go to APIs & Services >Credentials

    2. Click Create credentials >API Key.
    3. In the Create API key dialog, do the following:
      1. Enter a unique name for your API key.
      2. To restrict the key to the specific APIs that you enabled, select those APIs from the Select API restrictions list.
      3. Optional: In the Restrict your key to reduce security risks section, select an application type to restrict access.
      4. Click Create.

  3. Validate your API key by sending a test request to the service endpoint.

    • To verify a Cloud Translation API key, run the following command:

      curl-XPOST\
-H"Content-Type: application/json"\
-H"X-goog-api-key: YOUR_API_KEY"\
-d'{"q": "Hello world", "target": "es"}'\
"https://translation.googleapis.com/language/translate/v2"

      Replace YOUR_API_KEY with the API key that you generated.

    • To verify a Google Maps Weather API key, run the following command:

      curl-XGET\
"https://weather.googleapis.com/v1/currentConditions:lookup?key=YOUR_API_KEY&location.latitude=37.4220&location.longitude=-122.0841"

      Replace YOUR_API_KEY with the API key that you generated.

    If the API key is valid and configured correctly, the service returns the requested data.

Create an API key auth provider

Create an auth provider to define the configuration and credentials for third-party applications.

To create an API key auth provider, use the Google Cloud console or the Google Cloud CLI.

Console

  1. In the Google Cloud console, go to the Agent Registry page.

    Go to Agent Registry

  2. Click the name of the agent that you want to create an auth provider for.
  3. Click Identity.
  4. In the Auth Providers section, click Add auth provider.

  5. In the Add auth provider pane, enter a name and description.

    The name can contain only lowercase letters, numbers, or hyphens, cannot end with a hyphen, and must start with a lowercase letter.

  6. From the OAuth Type list, select API key .
  7. Click Create and continue.
  8. To grant your agent identity permission to use the auth provider, click Grant access.

    This automatically assigns the Connector User (roles/iamconnectors.user) role to the agent identity on the auth provider resource.

  9. In the Auth provider credentials section, enter the API key.
  10. Click Add provider config.

The newly created auth provider appears in the Auth Providers list.

Google Cloud CLI

  1. Create the auth provider:

    gcloudalphaagent-identityconnectorscreateAUTH_PROVIDER_NAME\
--project="PROJECT_ID"\
--location="LOCATION"\
--api-key="API_KEY"
  2. Verify that your auth provider appears in the list and its state is ENABLED: 
    gcloudalphaagent-identityconnectorslist\
--project="PROJECT_ID"\
--location="LOCATION"

  3. Grant access permissions to allow your agent and local development environment to retrieve credentials from the auth provider. To allow your deployed agent and your personal user account to access the auth provider, grant the Connector User (roles/iamconnectors.user) role on the auth provider resource:

    1. Grant access to your deployed agent's SPIFFE ID (Agent Identity):

      gcloudalphaagent-identityconnectorsadd-iam-policy-bindingAUTH_PROVIDER_NAME\
--project="PROJECT_ID"\
--location="LOCATION"\
--role="roles/iamconnectors.user"\
--member="principal://agents.global.org-ORGANIZATION_ID.system.id.goog/resources/aiplatform/projects/PROJECT_NUMBER/locations/LOCATION/reasoningEngines/ENGINE_ID"

    2. Grant access to your personal user account for local development and testing (adk web):

      gcloudalphaagent-identityconnectorsadd-iam-policy-bindingAUTH_PROVIDER_NAME\
--project="PROJECT_ID"\
--location="LOCATION"\
--role="roles/iamconnectors.user"\
--member="user:USER_EMAIL"

Replace the following:

  • PROJECT_ID: Your Google Cloud project ID.
  • LOCATION: The location where your auth provider and agent are deployed (for example, us-west1).
  • AUTH_PROVIDER_NAME: The name for your auth provider (for example, bigquery-mcp-3lo-authprovider).
  • AUTHORIZATION_URL: The authorization server URL (for example, https://accounts.google.com/o/oauth2/v2/auth).
  • TOKEN_URL: The token server URL (for example, https://oauth2.googleapis.com/token).
  • CLIENT_ID: The OAuth client ID you generated from the third-party service.
  • CLIENT_SECRET: The OAuth client secret you generated from the third-party service.
  • ORGANIZATION_ID: Your Google Cloud organization ID.
  • PROJECT_NUMBER: Your Google Cloud project number.
  • ENGINE_ID: The ID of your deployed reasoning engine agent.
  • USER_EMAIL: Your personal user account email address.

Authenticate in your agent code

To authenticate your agent, you can use the ADK.

ADK

Reference the auth provider in your agent's code using the MCP toolset in the ADK.

fromgoogle.adk.agents.llm_agentimport LlmAgent
fromgoogle.adk.auth.credential_managerimport CredentialManager
fromgoogle.adk.integrations.agent_identityimport GcpAuthProvider, GcpAuthProviderScheme
fromgoogle.adk.tools.mcp_tool.mcp_session_managerimport StreamableHTTPConnectionParams
fromgoogle.adk.tools.mcp_tool.mcp_toolsetimport McpToolset
fromgoogle.adk.auth.auth_toolimport AuthConfig
# Register the Google Cloud auth provider so the CredentialManager can use it.
CredentialManager.register_auth_provider(GcpAuthProvider())
# Create the Google Cloud auth provider scheme using the auth provider's full resource name.
auth_scheme = GcpAuthProviderScheme(
 name="projects/PROJECT_ID/locations/LOCATION/connectors/AUTH_PROVIDER_NAME"
)
# Configure an MCP tool with the authentication scheme.
toolset = McpToolset(
 connection_params=StreamableHTTPConnectionParams(url="https://YOUR_MCP_SERVER_URL"),
 auth_scheme=auth_scheme,
)
# Initialize the agent with the authenticated tools.
agent = LlmAgent(
 name="AGENT_NAME",
 model="gemini-2.5-flash",
 instruction="AGENT_INSTRUCTIONS",
 tools=[toolset],
)

Example: Connecting to Google Maps MCP

The following example demonstrates an agent.py configuration that connects an agent to a Google Maps MCP server:

importos
fromgoogle.adk.agentsimport Agent
fromgoogle.adk.appsimport App
fromgoogle.adk.auth.credential_managerimport CredentialManager
fromgoogle.adk.integrations.agent_identityimport GcpAuthProvider, GcpAuthProviderScheme
fromgoogle.adk.modelsimport Gemini
fromgoogle.adk.tools.mcp_tool.mcp_session_managerimport StreamableHTTPConnectionParams
fromgoogle.adk.tools.mcp_tool.mcp_toolsetimport McpToolset
os.environ["GOOGLE_CLOUD_PROJECT"] = "PROJECT_ID"
os.environ["GOOGLE_GENAI_USE_VERTEXAI"] = "True"
# Register Google Cloud auth provider for Agent Identity Credentials service
CredentialManager.register_auth_provider(GcpAuthProvider())
maps_auth_scheme = GcpAuthProviderScheme(
 name="projects/PROJECT_ID/locations/LOCATION/connectors/AUTH_PROVIDER_NAME"
)
maps_tools = McpToolset(
 connection_params=StreamableHTTPConnectionParams(url="https://mapstools.googleapis.com/mcp"),
 auth_scheme=maps_auth_scheme,
 errlog=None,
)
root_agent = Agent(
 name="root_agent",
 model=Gemini(model="gemini-2.5-flash"),
 instruction="You are a helpful AI assistant designed to provide accurate and useful information. You can also use your Google Maps tools to look up locations and directions.",
 tools=[maps_tools],
)
app = App(
 root_agent=root_agent,
 name="AGENT_NAME",
)

ADK

Reference the auth provider in your agent's code using an authenticated function tool in the ADK.

importhttpx
fromgoogle.adk.agents.llm_agentimport LlmAgent
fromgoogle.adk.auth.credential_managerimport CredentialManager
fromgoogle.adk.integrations.agent_identityimport GcpAuthProvider
fromgoogle.adk.integrations.agent_identityimport GcpAuthProviderScheme
fromgoogle.adk.appsimport App
fromgoogle.adk.auth.auth_credentialimport AuthCredential
fromgoogle.adk.auth.auth_toolimport AuthConfig
fromgoogle.adk.tools.authenticated_function_toolimport AuthenticatedFunctionTool
fromvertexaiimport agent_engines
# First, register Google Cloud auth provider
CredentialManager.register_auth_provider(GcpAuthProvider())
# Create Auth Config
spotify_auth_config = AuthConfig(
 auth_scheme=GcpAuthProviderScheme(
 name="projects/PROJECT_ID/locations/LOCATION/connectors/AUTH_PROVIDER_NAME"
 )
)
# Use the Auth Config in Authenticated Function Tool
spotify_search_track_tool = AuthenticatedFunctionTool(
 func=spotify_search_track, auth_config=spotify_auth_config
)
# Sample function tool
async defspotify_search_track(credential: AuthCredential, query: str) -> str | list:
 token = None
 if credential.http and credential.http.credentials:
 token = credential.http.credentials.token
 if not token:
 return "Error: No authentication token available."
 async with httpx.AsyncClient() as client:
 response = await client.get (
 "https://api.spotify.com/v1/search",
 headers={"Authorization": f"Bearer {token}"},
 params={"q": query, "type": "track", "limit": 1},
 )
 # Add your own logic here
agent = LlmAgent(
 name="AGENT_NAME",
 model="gemini-2.5-flash",
 instruction="AGENT_INSTRUCTIONS",
 tools=[spotify_search_track_tool],
)
app = App(
 name="APP_NAME",
 root_agent=agent,
)
vertex_app = agent_engines.AdkApp(app_name=app)

Example: Connecting to Google Maps Weather API

The following example demonstrates an agent.py configuration that connects an agent to the Google Maps Weather API using an authenticated function tool:

importos
importhttpx
fromgoogle.adk.agentsimport Agent
fromgoogle.adk.appsimport App
fromgoogle.adk.auth.auth_credentialimport AuthCredential
fromgoogle.adk.auth.auth_toolimport AuthConfig
fromgoogle.adk.auth.credential_managerimport CredentialManager
fromgoogle.adk.integrations.agent_identityimport GcpAuthProvider, GcpAuthProviderScheme
fromgoogle.adk.modelsimport Gemini
fromgoogle.adk.tools.authenticated_function_toolimport AuthenticatedFunctionTool
os.environ["GOOGLE_CLOUD_PROJECT"] = "PROJECT_ID"
os.environ["GOOGLE_GENAI_USE_VERTEXAI"] = "True"
# Register Google Cloud auth provider for Agent Identity Credentials service
CredentialManager.register_auth_provider(GcpAuthProvider())
weather_auth_config = AuthConfig(
 auth_scheme=GcpAuthProviderScheme(
 name="projects/PROJECT_ID/locations/LOCATION/connectors/AUTH_PROVIDER_NAME"
 )
)
async defget_weather(credential: AuthCredential, latitude: float, longitude: float) -> str | dict:
"""Gets the current weather conditions for a location using latitude and longitude."""
 api_key = None
 if http := credential.http:
 if http.additional_headers and "X-GOOG-API-KEY" in http.additional_headers:
 api_key = http.additional_headers["X-GOOG-API-KEY"]
 elif http.credentials and http.credentials.token:
 api_key = http.credentials.token
 if not api_key:
 return "Error: No API key available from the auth provider."
 params = {"location.latitude": latitude, "location.longitude": longitude, "key": api_key}
 async with httpx.AsyncClient() as client:
 response = await client.get(
 "https://weather.googleapis.com/v1/currentConditions:lookup",
 params=params,
 )
 if response.status_code != 200:
 return f"Error from Weather API: {response.status_code} - {response.text}"
 return response.json()
get_weather_tool = AuthenticatedFunctionTool(
 func=get_weather, auth_config=weather_auth_config
)
root_agent = Agent(
 name="root_agent",
 model=Gemini(model="gemini-2.5-flash"),
 instruction="You are a helpful AI assistant. You will use your weather tool to look up current conditions.",
 tools=[get_weather_tool],
)
app = App(
 root_agent=root_agent,
 name="AGENT_NAME",
)

ADK

Reference the auth provider in your agent's code using the Agent Registry MCP toolset in the ADK.

fromgoogle.adk.agents.llm_agentimport LlmAgent
fromgoogle.adk.auth.credential_managerimport CredentialManager
fromgoogle.adk.integrations.agent_identityimport GcpAuthProvider
fromgoogle.adk.integrations.agent_identityimport GcpAuthProviderScheme
fromgoogle.adk.tools.mcp_tool.mcp_session_managerimport StreamableHTTPConnectionParams
fromgoogle.adk.tools.mcp_tool.mcp_toolsetimport McpToolset
fromgoogle.adk.auth.auth_toolimport AuthConfig
fromgoogle.adk.integrations.agent_registryimport AgentRegistry
# First, register Google Cloud auth provider
CredentialManager.register_auth_provider(GcpAuthProvider())
# Create Google Cloud auth provider scheme by providing Auth Provider full resource name
auth_scheme = GcpAuthProviderScheme(
 name="projects/PROJECT_ID/locations/LOCATION/connectors/AUTH_PROVIDER_NAME"
)
# Set Agent Registry
registry = AgentRegistry(project_id="PROJECT_ID", location="global")
toolset = registry.get_mcp_toolset(mcp_server_name="projects/PROJECT_ID/locations/global/mcpServers/agentregistry-00000000-0000-0000-0000-000000000000", auth_scheme=auth_scheme)
# Example MCP tool
toolset = McpToolset(
 connection_params=StreamableHTTPConnectionParams(url="MCP_URL"),
 auth_scheme=auth_scheme,
)
agent = LlmAgent(
 name="AGENT_NAME",
 model="MODEL_NAME",
 instruction="AGENT_INSTRUCTIONS",
 tools=[toolset],
)

Deploy the agent

When you deploy your agent to Google Cloud, ensure that Agent Identity is enabled.

If you're deploying to Agent Runtime on Gemini Enterprise Agent Platform , use the identity_type=AGENT_IDENTITY flag:

importvertexai
fromvertexaiimport types
fromvertexai.agent_enginesimport AdkApp
# Initialize the Vertex AI client with v1beta1 API for Agent Identity support
client = vertexai .Client(
 project="PROJECT_ID",
 location="LOCATION",
 http_options=dict(api_version="v1beta1")
)
# Use the proper wrapper class for your Agent Framework (e.g., AdkApp)
app = AdkApp(agent=agent)
# Deploy the agent with Agent Identity enabled
remote_app = client.agent_engines .create(
 agent=app,
 config={
 "identity_type": types .IdentityType .AGENT_IDENTITY ,
 "requirements": ["google-cloud-aiplatform[agent_engines,adk]", "google-adk[agent-identity]"],
 },
)

What's next

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

Last updated 2026年08月28日 UTC.