SharedTokenCacheCredential Klasse
Authentifizierung mit Token in dem von Microsoft-Anwendungen gemeinsam genutzten lokalen Cache.
- Vererbung
-
builtins.objectSharedTokenCacheCredential
Konstruktor
SharedTokenCacheCredential(username: str | None = None, **kwargs: Any)
Parameter
- username
- str
Benutzername (in der Regel eine E-Mail-Adresse) des Benutzers, als der authentifiziert werden soll. Dies wird verwendet, wenn der lokale Cache Token für mehrere Identitäten enthält.
- authority
- str
Autorität eines Azure Active Directory-Endpunkts, z. B. "login.microsoftonline.com", der Autorität für die öffentliche Azure-Cloud (Dies ist die Standardeinstellung). AzureAuthorityHosts definiert Autoritäten für andere Clouds.
- tenant_id
- str
eine Azure Active Directory-Mandanten-ID. Wird verwendet, um ein Konto auszuwählen, wenn der Cache Token für mehrere Identitäten enthält.
- authentication_record
- AuthenticationRecord
ein Authentifizierungsdatensatz, der von Benutzeranmeldeinformationen wie DeviceCodeCredential oder zurückgegeben wird InteractiveBrowserCredential
- cache_persistence_options
- TokenCachePersistenceOptions
Konfiguration für die persistente Tokenzwischenspeicherung. Wenn nicht angegeben, verwenden die Anmeldeinformationen den von Microsoft-Entwicklungsanwendungen freigegebenen persistenten Cache.
Methoden
close |
Schließen Sie die Transportsitzung der Anmeldeinformationen. |
get_token |
Rufen Sie ein Zugriffstoken für Bereiche aus dem freigegebenen Cache ab. Wenn kein Zugriffstoken zwischengespeichert wird, versuchen Sie, mithilfe eines zwischengespeicherten Aktualisierungstokens ein Zugriffstoken abzurufen. Diese Methode wird von Azure SDK-Clients automatisch aufgerufen. |
supported |
Gibt an, ob der freigegebene Tokencache auf der aktuellen Plattform unterstützt wird. |
close
Schließen Sie die Transportsitzung der Anmeldeinformationen.
close() -> None
get_token
Rufen Sie ein Zugriffstoken für Bereiche aus dem freigegebenen Cache ab.
Wenn kein Zugriffstoken zwischengespeichert wird, versuchen Sie, mithilfe eines zwischengespeicherten Aktualisierungstokens ein Zugriffstoken abzurufen.
Diese Methode wird von Azure SDK-Clients automatisch aufgerufen.
get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken
Parameter
- scopes
- str
gewünschte Bereiche für das Zugriffstoken. Für diese Methode ist mindestens ein Bereich erforderlich. Weitere Informationen zu Bereichen finden Sie unter https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.
- claims
- str
Zusätzliche Ansprüche, die im Token erforderlich sind, z. B. solche, die in der Anspruchsanforderung eines Ressourcenanbieters nach einem Autorisierungsfehler zurückgegeben werden
- tenant_id
- str
von diesen Anmeldeinformationen nicht verwendet; Alle angegebenen Werte werden ignoriert.
- enable_cae
- bool
gibt an, ob die fortlaufende Zugriffsauswertung (Continuous Access Evaluation, CAE) für das angeforderte Token aktiviert werden soll. Der Standardwert lautet „False“.
Gibt zurück
Ein Zugriffstoken mit den gewünschten Bereichen.
Rückgabetyp
Ausnahmen
Der Cache ist nicht verfügbar oder enthält unzureichende Benutzerinformationen.
Fehler bei der Authentifizierung. Das Attribut des Fehlers message
gibt einen Grund an.
supported
Gibt an, ob der freigegebene Tokencache auf der aktuellen Plattform unterstützt wird.
static supported() -> bool
Gibt zurück
True, wenn der Cache für freigegebene Token auf der aktuellen Plattform unterstützt wird, andernfalls False.