Partager via

SharedTokenCacheCredential Classe

  • Référence

Procède à l’authentification à l’aide de jetons dans le cache local partagé entre les applications Microsoft.

Héritage
azure.identity._internal.shared_token_cache.SharedTokenCacheBase
SharedTokenCacheCredential
azure.identity.aio._internal.AsyncContextManager
SharedTokenCacheCredential

Constructeur

SharedTokenCacheCredential(username: str | None = None, *, authority: str | None = None, tenant_id: str | None = None, **kwargs: Any)

Paramètres

username
str
valeur par défaut: None

Nom d’utilisateur (généralement une adresse e-mail) de l’utilisateur à authentifier. Cela est obligatoire, car le cache local peut contenir des jetons pour plusieurs identités.

authority
str

Autorité d’un point de terminaison Azure Active Directory, par exemple « login.microsoftonline.com », l’autorité pour le cloud public Azure (qui est la valeur par défaut). AzureAuthorityHosts définit les autorités pour d’autres clouds.

tenant_id
str

un ID de locataire Azure Active Directory. Permet de sélectionner un compte lorsque le cache contient des jetons pour plusieurs identités.

cache_persistence_options
TokenCachePersistenceOptions

configuration pour la mise en cache des jetons persistants. Si elles ne sont pas fournies, les informations d’identification utilisent le cache persistant partagé par les applications de développement Microsoft.

Méthodes

close

Fermez la session de transport des informations d’identification.
get_token

Obtenez un jeton d’accès pour les étendues à partir du cache partagé.

Si aucun jeton d’accès n’est mis en cache, essayez d’en acquérir un à l’aide d’un jeton d’actualisation mis en cache.

Cette méthode est appelée automatiquement par les clients du Kit de développement logiciel (SDK) Azure.
supported

Indique si le cache de jetons partagé est pris en charge sur la plateforme actuelle.

close

Fermez la session de transport des informations d’identification.

async close() -> None

get_token

Obtenez un jeton d’accès pour les étendues à partir du cache partagé.

Si aucun jeton d’accès n’est mis en cache, essayez d’en acquérir un à l’aide d’un jeton d’actualisation mis en cache.

Cette méthode est appelée automatiquement par les clients du Kit de développement logiciel (SDK) Azure.

async get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken

Paramètres

scopes
str
Obligatoire

étendues souhaitées pour le jeton d’accès. Cette méthode nécessite au moins une étendue. Pour plus d’informations sur les étendues, consultez https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims
str

revendications supplémentaires requises dans le jeton, telles que celles retournées dans la contestation de revendications d’un fournisseur de ressources suite à un échec d’autorisation.

tenant_id
str

locataire facultatif à inclure dans la demande de jeton.

enable_cae
bool

indique s’il faut activer l’évaluation continue de l’accès (CAE) pour le jeton demandé. Valeur par défaut False.

Retours

Jeton d’accès avec les étendues souhaitées.

Type de retour

AccessToken

Exceptions

CredentialUnavailableError

le cache n’est pas disponible ou contient des informations utilisateur insuffisantes

ClientAuthenticationError

échec de l’authentification. L’attribut de l’erreur message donne une raison. Toute réponse d’erreur d’Azure Active Directory est disponible en tant qu’attribut de l’erreur response .

supported

Indique si le cache de jetons partagé est pris en charge sur la plateforme actuelle.

static supported() -> bool

Retours

True si le cache de jeton partagé est pris en charge sur la plateforme actuelle.

Type de retour

bool