Skip to content

Commit 05e3c46

Browse files
authored
Clarify BYOK token usage and limitations (#402)
1 parent 2186bf2 commit 05e3c46

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/auth/byok.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -272,19 +272,23 @@ provider: {
272272
}
273273
```
274274

275+
> **Note:** The `bearerToken` option accepts a **static token string** only. The SDK does not refresh this token automatically. If your token expires, requests will fail and you'll need to create a new session with a fresh token.
276+
275277
## Limitations
276278

277279
When using BYOK, be aware of these limitations:
278280

279281
### Identity Limitations
280282

281-
BYOK authentication is **key-based only**. The following identity providers are NOT supported:
283+
BYOK authentication uses **static credentials only**. The following identity providers are NOT supported:
282284

283285
-**Microsoft Entra ID (Azure AD)** - No support for Entra managed identities or service principals
284286
-**Third-party identity providers** - No OIDC, SAML, or other federated identity
285287
-**Managed identities** - Azure Managed Identity is not supported
286288

287-
You must use an API key or bearer token that you manage yourself.
289+
You must use an API key or static bearer token that you manage yourself.
290+
291+
**Why not Entra ID?** While Entra ID does issue bearer tokens, these tokens are short-lived (typically 1 hour) and require automatic refresh via the Azure Identity SDK. The `bearerToken` option only accepts a static string—there is no callback mechanism for the SDK to request fresh tokens. For long-running workloads requiring Entra authentication, you would need to implement your own token refresh logic and create new sessions with updated tokens.
288292

289293
### Feature Limitations
290294

0 commit comments

Comments
 (0)