UsernamePasswordCredential Clase
Autentica a un usuario con un nombre de usuario y una contraseña.
En general, Microsoft no recomienda este tipo de autenticación, ya que es menos seguro que otros flujos de autenticación.
La autenticación con esta credencial no es interactiva, por lo que no es compatible con ninguna forma de autenticación multifactor o solicitud de consentimiento. La aplicación ya debe tener el consentimiento del usuario o un administrador de directorios.
Esta credencial solo puede autenticar cuentas profesionales y educativas; No se admiten cuentas de Microsoft. Consulte la documentación de Azure Active Directory para obtener más información sobre los tipos de cuenta.
- Herencia
-
azure.identity._internal.interactive.InteractiveCredentialUsernamePasswordCredential
Constructor
UsernamePasswordCredential(client_id: str, username: str, password: str, **kwargs: Any)
Parámetros
- username
- str
Nombre de usuario del usuario (normalmente una dirección de correo electrónico)
- 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 autoridades para otras nubes.
- tenant_id
- str
Identificador de inquilino o dominio asociado a un inquilino. Si no se proporciona, el valor predeterminado es el inquilino de "organizaciones", que solo admite cuentas profesionales o educativas de Azure Active Directory.
- cache_persistence_options
- TokenCachePersistenceOptions
Configuración para el almacenamiento en caché de tokens persistentes. Si no se especifica, la credencial almacenará en caché los tokens en memoria.
- 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 la 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 la recuperación de metadatos de autoridad de https://login.microsoft.com/ para validar la autoridad. Al establecer esto en True, la validación de la entidad está deshabilitada. Como resultado, es fundamental asegurarse de que el host de autoridad configurado sea válido y de confianza.
Especifica los inquilinos además del especificado "tenant_id" para el que la credencial puede adquirir tokens. Agregue el valor de carácter comodín "*" para permitir que la credencial adquiera tokens para cualquier inquilino al que pueda acceder la aplicación.
Ejemplos
Cree un elemento UsernamePasswordCredential.
from azure.identity import UsernamePasswordCredential
credential = UsernamePasswordCredential(
client_id="<client_id>",
username="<username>",
password="<password>",
)
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
á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.
Tipo de valor devuelto
Excepciones
error de autenticación. El atributo del message
error proporciona una razón.
close
close() -> None
Excepciones
error de autenticación. El atributo del message
error proporciona una razón.
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
á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
Excepciones
la credencial no puede intentar la autenticación porque carece de compatibilidad con los datos, el estado o la plataforma necesarios.
error de autenticación. El atributo del message
error proporciona una razón.
La interacción del usuario es necesaria para adquirir un token y la credencial está configurada para no comenzar esto automáticamente. Call
para comenzar la autenticación interactiva.
Comentarios
https://aka.ms/ContentUserFeedback.
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea:Enviar y ver comentarios de