AuthorizationCodeCredential Clase

Se autentica canjeando un código de autorización obtenido previamente de Azure Active Directory.

Consulte la documentación de Azure Active Directory para más información sobre el flujo de autenticación.

Herencia

azure.identity._internal.get_token_mixin.GetTokenMixin

AuthorizationCodeCredential

Constructor

AuthorizationCodeCredential(tenant_id: str, client_id: str, authorization_code: str, redirect_uri: str, **kwargs: Any)

Parámetros

tenant_id

str

Requerido

Identificador del inquilino de Azure Active Directory de la aplicación. También se denomina identificador de "directorio".

client_id

str

Requerido

Identificador de cliente de la aplicación

authorization_code

str

Requerido

El código de autorización del inicio de sesión del usuario

redirect_uri

str

Requerido

URI de redirección de la aplicación. Debe coincidir con el URI usado para solicitar el código de autorización.

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.

client_secret

str

Uno de los secretos de cliente de la aplicación. Solo es necesario para las aplicaciones web y las API web.

additionally_allowed_tenants

List[str]

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 una authorizationCodeCredential.

   from azure.identity import AuthorizationCodeCredential

   credential = AuthorizationCodeCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       authorization_code="<auth_code>",
       redirect_uri="<redirect_uri>",
   )

Métodos

close

Cierre la sesión de transporte de la credencial.

get_token

Solicite un token de acceso para los ámbitos. Los clientes del SDK de Azure llaman automáticamente a este método. La primera vez que se llama a este método, la credencial canjeará su código de autorización. En las llamadas posteriores, la credencial devolverá un token de acceso almacenado en caché o canjeará un token de actualización, si adquirió un token de actualización al canjear el código de autorización.

close

Cierre la sesión de transporte de la credencial.

close() -> None

get_token

Solicite un token de acceso para los ámbitos.

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

La primera vez que se llama a este método, la credencial canjeará su código de autorización. En las llamadas posteriores, la credencial devolverá un token de acceso almacenado en caché o canjeará un token de actualización, si adquirió un token de actualización al canjear el código de autorización.

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.

Devoluciones

Un token de acceso con los ámbitos deseados.

Tipo de valor devuelto

AccessToken

Excepciones

ClientAuthenticationError

error de autenticación. El atributo del message error proporciona una razón. Cualquier respuesta de error de Azure Active Directory está disponible como atributo del response error.