InteractiveBrowserCredential Classe

Ouvre un navigateur pour authentifier un utilisateur de manière interactive.

get_token ouvre un navigateur à une URL de connexion fournie par Azure Active Directory et authentifie un utilisateur avec le flux de code d’autorisation, en utilisant PKCE (Proof Key for Code Exchange) en interne pour protéger le code.

Héritage
azure.identity._internal.interactive.InteractiveCredential
InteractiveBrowserCredential

Constructeur

InteractiveBrowserCredential(**kwargs: Any)

Paramètres

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. Par défaut, le locataire « organisations » peut authentifier les comptes professionnels ou scolaires.

client_id
str

ID client de l’application Azure Active Directory à laquelle les utilisateurs se connecteront. S’il n’est pas spécifié, les utilisateurs s’authentifient auprès d’une application de développement Azure.

login_hint
str

une suggestion de nom d’utilisateur pour pré-remplir le champ nom d’utilisateur/adresse e-mail de la page de connexion. Un utilisateur peut toujours se connecter avec un nom d’utilisateur différent.

redirect_uri
str

UN URI de redirection pour l’application identifiée par client_id comme configuré dans Azure Active Directory, par exemple «http://localhost:8400 ». Cela est nécessaire uniquement lors du passage d’une valeur pour client_id et doit correspondre à un URI de redirection dans l’inscription de l’application. Les informations d’identification doivent être en mesure de lier un socket à cet URI.

authentication_record
AuthenticationRecord

AuthenticationRecord retourné par authenticate

disable_automatic_authentication
bool

si la valeur est True, get_token se déclenche AuthenticationRequiredError lorsque l’utilisateur doit interagir pour acquérir un jeton. Valeur par défaut False.

cache_persistence_options
TokenCachePersistenceOptions

configuration pour la mise en cache des jetons persistants. Si elles ne sont pas spécifiées, les informations d’identification mettez en cache les jetons en mémoire.

timeout
int

secondes avant d’attendre que l’utilisateur termine l’authentification. La valeur par défaut est 300 (5 minutes).

disable_instance_discovery
bool

Détermine si instance découverte est effectuée lors de la tentative d’authentification. La définition de cette valeur sur true désactive complètement la découverte instance et la validation de l’autorité. Cette fonctionnalité est destinée à être utilisée dans les scénarios où le point de terminaison de métadonnées n’est pas accessible, par exemple dans des clouds privés ou Azure Stack. Le processus de découverte instance implique la récupération des métadonnées d’autorité à partir de https://login.microsoft.com/ pour valider l’autorité. En affectant la valeur True, la validation de l’autorité est désactivée. Par conséquent, il est essentiel de s’assurer que l’hôte d’autorité configuré est valide et digne de confiance.

Exemples

Créez un objet InteractiveBrowserCredential.


   from azure.identity import InteractiveBrowserCredential

   credential = InteractiveBrowserCredential(
       client_id="<client_id>",
   )

Méthodes

authenticate

Authentifier un utilisateur de manière interactive.

close
get_token

Demandez un jeton d’accès pour les étendues.

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

authenticate

Authentifier un utilisateur de manière interactive.

authenticate(**kwargs: Any) -> AuthenticationRecord

Paramètres

scopes
Iterable[str]

étendues à demander pendant l’authentification, telles que celles fournies par scopes. Si elle est fournie, l’authentification réussie met en cache un jeton d’accès pour ces étendues.

claims
str

revendications supplémentaires requises dans le jeton, telles que celles fournies par claims

Type de retour

Exceptions

échec de l’authentification. L’attribut de l’erreur message donne une raison.

close

close() -> None

Exceptions

échec de l’authentification. L’attribut de l’erreur message donne une raison.

get_token

Demandez un jeton d’accès pour les étendues.

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

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 demande 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

Exceptions

les informations d’identification ne peuvent pas tenter d’authentification, car elles ne disposent pas de la prise en charge des données, de l’état ou de la plateforme requises

échec de l’authentification. L’attribut de l’erreur message donne une raison.

L’interaction utilisateur est nécessaire pour acquérir un jeton, et les informations d’identification sont configurées pour ne pas commencer automatiquement. Appeler

pour commencer l’authentification interactive.