AuthorizationCodeCredential Classe
Autentica ao resgatar um código de autorização obtido anteriormente a partir do Azure Active Directory.
Veja Documentação do Azure Active Directory para obter mais informações sobre o fluxo de autenticação.
- Herança
-
azure.identity._internal.get_token_mixin.GetTokenMixinAuthorizationCodeCredential
Construtor
AuthorizationCodeCredential(tenant_id: str, client_id: str, authorization_code: str, redirect_uri: str, **kwargs: Any)
Parâmetros
- tenant_id
- str
ID do inquilino do Azure Active Directory da aplicação. Também chamou o respetivo ID de "diretório".
- redirect_uri
- str
O URI de redirecionamento da aplicação. Tem de corresponder ao URI utilizado para pedir o código de autorização.
- authority
- str
Autoridade de um ponto final do Azure Active Directory, por exemplo "login.microsoftonline.com", a autoridade para a Cloud Pública do Azure (que é a predefinição). AzureAuthorityHosts define as autoridades para outras clouds.
- client_secret
- str
Um dos segredos do cliente da aplicação. Necessário apenas para aplicações Web e APIs Web.
Especifica inquilinos para além do "tenant_id" especificado para o qual a credencial pode adquirir tokens. Adicione o valor universal "*" para permitir que a credencial adquira tokens para qualquer inquilino a que a aplicação possa aceder.
Exemplos
Crie um 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 |
Feche a sessão de transporte da credencial. |
get_token |
Pedir um token de acesso para âmbitos. Este método é chamado automaticamente pelos clientes do SDK do Azure. Na primeira vez que este método for chamado, a credencial resgatará o código de autorização. Nas chamadas subsequentes, a credencial devolverá um token de acesso em cache ou resgatará um token de atualização, se tiver adquirido um token de atualização ao resgatar o código de autorização. |
close
Feche a sessão de transporte da credencial.
close() -> None
get_token
Pedir um token de acesso para âmbitos.
Este método é chamado automaticamente pelos clientes do SDK do Azure.
Na primeira vez que este método for chamado, a credencial resgatará o código de autorização. Nas chamadas subsequentes, a credencial devolverá um token de acesso em cache ou resgatará um token de atualização, se tiver adquirido um token de atualização ao resgatar o código de autorização.
get_token(*scopes: str, claims: str | None = None, tenant_id: str | None = None, **kwargs: Any) -> AccessToken
Parâmetros
- scopes
- str
âmbitos pretendidos para o token de acesso. Este método requer, pelo menos, um âmbito. Para obter mais informações sobre âmbitos, consulte https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.
- claims
- str
afirmações adicionais necessárias no token, como as devolvidas no desafio de afirmações de um fornecedor de recursos na sequência de uma falha de autorização.
- tenant_id
- str
inquilino opcional a incluir no pedido de token.
Devoluções
Um token de acesso com os âmbitos pretendidos.
Tipo de retorno
Exceções
falha na autenticação. O atributo do message
erro dá um motivo. Qualquer resposta de erro do Azure Active Directory está disponível como atributo do response
erro.