InteractiveBrowserCredential Clase

Abre un explorador para autenticar interactivamente a un usuario.

get_token abre un explorador en una dirección URL de inicio de sesión proporcionada por Azure Active Directory y autentica a un usuario allí con el flujo de código de autorización, mediante PKCE (clave de prueba para Intercambio de código) internamente para proteger el código.

Herencia

azure.identity._internal.interactive.InteractiveCredential

InteractiveBrowserCredential

Constructor

InteractiveBrowserCredential(**kwargs: Any)

Parámetros

authority

str

Autoridad de un punto de conexión de Azure Active Directory, por ejemplo, "login.microsoftonline.com", la autoridad de la nube pública de Azure (que es el valor predeterminado). AzureAuthorityHosts define las autoridades para otras nubes.

tenant_id

str

un identificador de inquilino de Azure Active Directory. El valor predeterminado es el inquilino de "organizaciones", que puede autenticar cuentas profesionales o educativas.

client_id

str

El identificador de cliente de los usuarios de la aplicación de Azure Active Directory iniciará sesión. Si no se especifica, los usuarios se autenticarán en una aplicación de desarrollo de Azure.

login_hint

str

una sugerencia de nombre de usuario para rellenar previamente el campo nombre de usuario o dirección de correo electrónico de la página de inicio de sesión. Un usuario puede seguir iniciando sesión con un nombre de usuario diferente.

redirect_uri

str

un URI de redireccionamiento para la aplicación identificada por client_id como configurada en Azure Active Directory, por ejemplo, "http://localhost:8400". Esto solo es necesario al pasar un valor para client_id y debe coincidir con un URI de redireccionamiento en el registro de la aplicación. La credencial debe poder enlazar un socket a este URI.

authentication_record

AuthenticationRecord

AuthenticationRecord devuelto por authenticate

disable_automatic_authentication

bool

si es True, get_token se generará AuthenticationRequiredError cuando se requiera la interacción del usuario para adquirir un token. El valor predeterminado es False.

cache_persistence_options

TokenCachePersistenceOptions

configuración para el almacenamiento en caché de tokens persistente. Si no se especifica, la credencial almacenará en caché los tokens en memoria.

timeout

int

segundos para esperar a que el usuario complete la autenticación. El valor predeterminado es 300 (5 minutos).

disable_instance_discovery

bool

Determina si se realiza o no la detección de instancias al intentar autenticarse. Si se establece en true, se deshabilitará completamente la detección de instancias y la validación de autoridad. Esta funcionalidad está pensada para su uso en escenarios en los que no se puede acceder al punto de conexión de metadatos, como en nubes privadas o Azure Stack. El proceso de detección de instancias implica recuperar los metadatos de autoridad de https://login.microsoft.com/ para validar la autoridad. Al establecer esto en True, la validación de la autoridad está deshabilitada. Como resultado, es fundamental asegurarse de que el host de autoridad configurado sea válido y confiable.

Ejemplos

Cree un interactiveBrowserCredential.

   from azure.identity import InteractiveBrowserCredential

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

Métodos

authenticate	Autenticación interactiva de un usuario.
close
get_token	Solicite un token de acceso para los ámbitos. Los clientes del SDK de Azure llaman automáticamente a este método.

authenticate

Autenticación interactiva de un usuario.

authenticate(**kwargs: Any) -> AuthenticationRecord

Parámetros

scopes

Iterable[str]

ámbitos para solicitar durante la autenticación, como los proporcionados por scopes. Si se proporciona, la autenticación correcta almacenará en caché un token de acceso para estos ámbitos.

claims

str

Notificaciones adicionales necesarias en el token, como las proporcionadas por claims

Tipo de valor devuelto

AuthenticationRecord

Excepciones

ClientAuthenticationError

error de autenticación. El atributo del message error proporciona un motivo.

close

close() -> None

Excepciones

ClientAuthenticationError

error de autenticación. El atributo del message error proporciona un motivo.

get_token

Solicite un token de acceso para los ámbitos.

Los clientes del SDK de Azure llaman automáticamente a este método.

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

Parámetros

scopes

str

Requerido

ámbitos deseados para el token de acceso. Este método requiere al menos un ámbito. Para obtener más información sobre los ámbitos, vea https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims

str

Notificaciones adicionales necesarias en el token, como las que se devuelven en el desafío de notificaciones de un proveedor de recursos después de un error de autorización

tenant_id

str

inquilino opcional que se va a incluir en la solicitud de token.

enable_cae

bool

indica si se va a habilitar la evaluación continua de acceso (CAE) para el token solicitado. El valor predeterminado es False.

Devoluciones

Un token de acceso con los ámbitos deseados.

Tipo de valor devuelto

AccessToken

Excepciones

CredentialUnavailableError

la credencial no puede intentar la autenticación porque no tiene compatibilidad con los datos, el estado o la plataforma necesarios.

ClientAuthenticationError

error de autenticación. El atributo del message error proporciona un motivo.

AuthenticationRequiredError

La interacción del usuario es necesaria para adquirir un token y la credencial está configurada para no comenzar esto automáticamente. Call

authenticate

para iniciar la autenticación interactiva.