AuthenticationContext Classe
Récupère les jetons d’authentification à partir d’Azure Active Directory.
Pour les utilisations, case activée le dossier « sample » à l’adresse suivante :https://github.com/AzureAD/azure-activedirectory-library-for-python
Crée un objet AuthenticationContext.
Par défaut, l’autorité est vérifiée par rapport à une liste d’autorités Azure Active Directory connues. Si l’autorité n’est pas reconnue comme l’une de ces autorités connues, l’acquisition de jetons échoue. Ce comportement peut être désactivé via le paramètre validate_authority ci-dessous.
- Héritage
-
builtins.objectAuthenticationContext
Constructeur
AuthenticationContext(authority, validate_authority=None, cache=None, api_version=None, timeout=None, enable_pii=False, verify_ssl=None, proxies=None)Paramètres
- authority
- str
URL qui identifie une autorité de jeton. Il doit être au format https://login.microsoftonline.com/your_tenant
- validate_authority
- bool
(facultatif) Active ou désactive la validation de l’autorité. Par défaut, ce paramètre a la valeur true.
- cache
- TokenCache
(facultatif) Définit le cache de jetons utilisé par ce instance AuthenticationContext. Si ce paramètre n’est pas défini, une valeur par défaut est utilisée. Les instances de cache sont utilisées uniquement par cette instance d’AuthenticationContext et ne sont pas partagées, sauf si elles ont été transmises manuellement lors de la construction d’autres AuthenticationContexts.
- api_version
(facultatif) Spécifie la version de l’API à l’aide de sur le réseau. Historiquement, il a une valeur par défaut codée en dur comme « 1.0 ». Les développeurs ont été encouragés à la définir sur None explicitement, ce qui signifie que la version de l’API sous-jacente sera automatiquement choisie. À partir d’ADAL Python 1.0, cette valeur par défaut devient None.
- timeout
(facultatif) demande un délai d’expiration. Durée d’attente avant que le serveur envoie des données avant de renoncer à un tuple float ou (délai d’attente de connexion, délai d’expiration de lecture).
- enable_pii
(facultatif) Sauf si cette valeur est définie sur True, aucune information d’identification personnelle (PII) n’est écrite dans le journal.
- verify_ssl
(facultatif) demandes de vérification. Soit une valeur booléenne, auquel cas elle contrôle si nous vérifions le certificat TLS du serveur, soit une chaîne, auquel cas il doit s’agir d’un chemin d’accès à un bundle d’autorité de certification à utiliser. Si cette valeur n’est pas fournie et ADAL_PYTHON_SSL_NO_VERIFY valeur env est définie, le comportement équivaut à verify_ssl=False.
- proxies
(facultatif) demande des proxys. Protocole de mappage de dictionnaire à l’URL du proxy. Pour plus d'informations, consultez http://docs.python-requests.org/en/master/user/advanced/#proxies.
Méthodes
| acquire_token |
Obtient un jeton pour une ressource donnée via des jetons mis en cache. |
| acquire_token_with_authorization_code |
Obtient un jeton pour une ressource donnée via le code d’autorisation d’une application serveur. |
| acquire_token_with_client_certificate |
Obtient un jeton pour une ressource donnée via les informations d’identification de certificat |
| acquire_token_with_client_credentials |
Obtient un jeton pour une ressource donnée via les informations d’identification du client. |
| acquire_token_with_device_code |
Obtient un nouveau jeton d’accès à l’aide d’un code d’appareil. |
| acquire_token_with_refresh_token |
Obtient un jeton pour une ressource donnée via des jetons d’actualisation |
| acquire_token_with_username_password |
Obtient un jeton pour une ressource donnée via des credentails utilisateur. |
| acquire_user_code |
Obtient les informations de code utilisateur qui contiennent user_code, device_code pour l’authentification de l’utilisateur sur l’appareil. |
| cancel_request_to_get_token_with_device_code |
Annule la demande d’interrogation pour obtenir le jeton avec le code de l’appareil. |
acquire_token
Obtient un jeton pour une ressource donnée via des jetons mis en cache.
acquire_token(resource, user_id, client_id)Paramètres
- user_id
- str
Le nom d’utilisateur de l’utilisateur au nom de cette application s’authentifie.
Retours
dic avec plusieurs clés, incluez « accessToken » et « refreshToken ».
acquire_token_with_authorization_code
Obtient un jeton pour une ressource donnée via le code d’autorisation d’une application serveur.
acquire_token_with_authorization_code(authorization_code, redirect_uri, resource, client_id, client_secret=None, code_verifier=None)Paramètres
- client_secret
- str
(uniquement pour les clients confidentiels) Clé secrète client OAuth de l’application appelante. Ce paramètre s’il n’est pas défini, la valeur par défaut est None
- code_verifier
- str
(facultatif) Vérificateur de code utilisé pour obtenir le code d’autorisation si PKCE a été utilisé dans la demande d’octroi de code d’autorisation. (généralement utilisé par les clients publics) Ce paramètre s’il n’est pas défini, la valeur par défaut est None
Retours
dict avec plusieurs clés, incluez « accessToken » et « refreshToken ».
acquire_token_with_client_certificate
Obtient un jeton pour une ressource donnée via les informations d’identification de certificat
acquire_token_with_client_certificate(resource, client_id, certificate, thumbprint, public_certificate=None)Paramètres
- public_certificate
Si ce n’est pas le cas, il est envoyé au service pour l’authentification basée sur le nom de l’objet et l’émetteur, qui prend en charge les rolls automatiques de certificat. La valeur doit correspondre au paramètre de clé privée du certificat.
Retours
dict avec plusieurs clés, incluez « accessToken ».
acquire_token_with_client_credentials
Obtient un jeton pour une ressource donnée via les informations d’identification du client.
acquire_token_with_client_credentials(resource, client_id, client_secret)Paramètres
Retours
dict avec plusieurs clés, incluez « accessToken ».
acquire_token_with_device_code
Obtient un nouveau jeton d’accès à l’aide d’un code d’appareil.
acquire_token_with_device_code(resource, user_code_info, client_id)Paramètres
Retours
dict avec plusieurs clés, incluez « accessToken » et « refreshToken ».
acquire_token_with_refresh_token
Obtient un jeton pour une ressource donnée via des jetons d’actualisation
acquire_token_with_refresh_token(refresh_token, client_id, resource, client_secret=None)Paramètres
- refresh_token
- str
Jeton d’actualisation retourné dans une réponse tokne à partir d’un appel précédent de acquireToken.
- client_secret
- str
(facultatif) Clé secrète client OAuth de l’application appelante.
Retours
dict avec plusieurs clés, incluez « accessToken » et « refreshToken ».
acquire_token_with_username_password
Obtient un jeton pour une ressource donnée via des credentails utilisateur.
acquire_token_with_username_password(resource, username, password, client_id)Paramètres
- username
- str
Le nom d’utilisateur de l’utilisateur au nom de cette application s’authentifie.
Retours
dict avec plusieurs clés, incluez « accessToken » et « refreshToken ».
acquire_user_code
Obtient les informations de code utilisateur qui contiennent user_code, device_code pour l’authentification de l’utilisateur sur l’appareil.
acquire_user_code(resource, client_id, language=None)Paramètres
- resource
- str
URI qui identifie la ressource pour laquelle le device_code et l’user_code sont valides.
- language
- str
Code de langue spécifiant la façon dont le message doit être localisé.
Retours
dict contient le code et l’URI permettant aux utilisateurs de se connecter via le navigateur.
cancel_request_to_get_token_with_device_code
Annule la demande d’interrogation pour obtenir le jeton avec le code de l’appareil.
cancel_request_to_get_token_with_device_code(user_code_info)Paramètres
Retours
Aucun
Attributs
options
Azure SDK for Python
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour