Clearer diagnostic when an API Key SID is passed without `account_sid`

Offen Anfängerfreundlich
#985 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

@saryeljaramany arbeitet bereits daran.

Seit 14.11.2026.

  • #990 von @saryeljaramany — offen

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
82/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
python
Bereich
api

Rechercherichtung

Beginne mit twilio/base/client_base.py am Fallback für account_sid und prüfe die zugehörigen Unit-Tests unter tests/unit. Ergänze Tests für eine API Key SID ohne account_sid und prüfe, dass ein explizites account_sid und die vorhandene Token-Einrichtung weiterhin funktionieren. Das Ziel ist erreicht, wenn der Fall mit fehlender Account SID einen umsetzbaren Fehler ausgibt und die relevanten Tests bestehen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Location (twilio/twilio-python @ default branch 74b9629):

        self.account_sid = account_sid or self.username

Problem

The README shows API-key authentication as Client(api_key, api_secret, account_sid). If the third argument is forgotten, e.g. Client("SKxxxx...", "secret"), the constructor accepts it and ClientBase.__init__ falls back to self.account_sid = account_sid or self.username, so the API Key SID is used as the account SID in account-scoped resource paths. The fallback is silent: there is no validation or hint in the constructor, and the mistake only surfaces later as an authentication/not-found error from the API, which does not point at the missing account_sid.

Reproduction

from twilio.rest import Client

client = Client("SK" + "a" * 32, "my-api-secret")   # no error
print(client.account_sid)                            # 'SKaaaa...'
client.messages.create(...)                          # fails later with an API error

Environment:

  • Commit: 74b96296b0805986252b798bda4bca90341487ee (main, twilio 9.12.0)
  • Toolchain: Python 3.13.18

Workaround: always pass account_sid= explicitly when authenticating with API keys.

Already fixed in twilio/twilio-node

PR: https://github.com/twilio/twilio-node/pull/828 — "fix: give more descriptive error for accountSid init issues" (merged 2022-11-28T17:54:36Z, merge commit e18440d317c). When the SID used as accountSid starts with SK, the constructor error now says that an API Key requires the accountSid to be passed as an additional option. twilio-node already rejects non-AC account SIDs; that check is not being proposed here, only the API Key hint.

How twilio-node fixed it:

--- a/lib/base/BaseTwilio.ts
+++ b/lib/base/BaseTwilio.ts
@@ -88,7 +88,11 @@ export class BaseTwilio {
...
     if (!this.accountSid?.startsWith("AC")) {
-      throw new Error("accountSid must start with AC");
+      const apiKeyMsg = this.accountSid.startsWith("SK")
+        ? ". The given SID indicates an API Key which requires the accountSid to be passed as an additional option"
+        : "";
+
+      throw new Error("accountSid must start with AC" + apiKeyMsg);

Suggested fix

Mirroring twilio-node's API Key hint, ClientBase.__init__ raises a TwilioException with an actionable message when username starts with SK and neither account_sid nor a credential_provider is given; no AC prefix is enforced and other setups are unchanged:

diff --git a/twilio/base/client_base.py b/twilio/base/client_base.py
--- a/twilio/base/client_base.py
+++ b/twilio/base/client_base.py
@@ -4,6 +4,7 @@ from typing import Dict, List, MutableMapping, Optional, Tuple
 from urllib.parse import urlparse, urlunparse
 
 from twilio import __version__
+from twilio.base.exceptions import TwilioException
 from twilio.http import HttpClient
 from twilio.http.http_client import TwilioHttpClient
 from twilio.http.response import Response
@@ -54,6 +55,17 @@ class ClientBase(object):
         self.credential_provider = credential_provider or None
         """ :type : CredentialProvider """
 
+        if (
+            not account_sid
+            and not self.credential_provider
+            and self.username
+            and self.username.startswith("SK")
+        ):
+            raise TwilioException(
+                "The given username indicates an API Key SID, which requires "
+                "your Account SID to be passed via account_sid"
+            )
+
         self.account_sid = account_sid or self.username
         """ :type : str """
         self.auth = (self.username, self.password)

Verified on 74b9629 (Python 3.13.18, pytest 9.2.0): a unit test for the reproduction above (Client("SK...", "my-api-secret") must raise an error mentioning the API Key and account_sid, while Client("SK...", secret, account_sid="AC...") and Client("AC...", token) keep working) fails without this patch and passes with it; no other test results change in tests/unit.

I can submit a PR for this.

Checked: #259 / #286 (2016) were about API-key auth not being supported/how to pass the account SID; they predate the current account_sid parameter and don't cover diagnosing the omission.

Vorherrschende Sprache
Python
Sterne
2.1k
Forks
821
Ø Merge
9 Std. 33 Min.
Gemergte PRs (30 T.)
3

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus twilio/twilio-python

Alle Issues in twilio/twilio-python

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.