Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

[FEATURE REQ] Provide native support for API key–based authentication, similar to other SDKs.

Abierto
#48,868 1 comentario 0 reacciones 5 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

@trrwilson ya está trabajando en esto.

Desde el 8/8/2026.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

AI Agents customer-reported feature-request needs-team-attention Service Attention

Currently, the com.azure:azure-ai-agents:2.0.1 SDK enforces a Bearer token–based authentication model via TokenCredential.
However, when using Azure API Management (APIM) in front of Azure OpenAI/Agents endpoints, authentication is commonly handled using API Key headers (e.g., x-api-key), not Bearer tokens.

At the moment, there is no first-class support to pass API key–based credentials. Even when attempting to override the pipeline manually (as shown below), the SDK still expects a credential and does not provide a clean or supported way to use API key authentication.

val builder = AgentsClientBuilder()
builder.endpoint(baseUrl)
builder.httpLogOptions(HttpLogOptions().setLogLevel(HttpLogDetailLevel.BODY_AND_HEADERS))

val httpClient = HttpClient.createDefault()
val headers = HttpHeaders()
headers.set(credentials.keyName, credentials.keyValue)

val pipeline = HttpPipelineBuilder()
    .policies(AddHeadersPolicy(headers))
    .httpClient(httpClient)
    .build()

builder.pipeline(pipeline)

// Forced workaround
builder.credential(null)

val client = builder.buildAgentsClient()

This approach is fragile and not officially supported, making integration with APIM cumbersome.

Describe the solution

For example:
Add a method like:

builder.apiKeyCredential(ApiKeyCredential("key-name", "key-value"))

Alternatively, allow:

Custom headers to be injected without requiring TokenCredential
A dedicated AzureApiKeyCredential or similar abstraction
This would make it seamless to integrate with Azure APIM endpoints.

Lenguaje dominante
Java
Estrellas
2.6k
Forks
2.2k
Merge medio
1 d 22 h
PR fusionados (30 d)
213

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Azure/azure-sdk-for-java

Todos los issues de Azure/azure-sdk-for-java

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.