AuthorizationCodeCredential Classe

  • Referência

Autentica-se resgatando um código de autorização obtido anteriormente do Azure Active Directory.

Confira a documentação do Azure Active Directory para obter mais informações sobre o fluxo de autenticação.

Herança
azure.identity.aio._internal.AsyncContextManager
AuthorizationCodeCredential
azure.identity.aio._internal.get_token_mixin.GetTokenMixin
AuthorizationCodeCredential

Construtor

AuthorizationCodeCredential(tenant_id: str, client_id: str, authorization_code: str, redirect_uri: str, *, client_secret: str | None = None, **kwargs)

Parâmetros

tenant_id
str
Obrigatório

ID do locatário do Azure Active Directory do aplicativo. Também chamou sua ID de "diretório".

client_id
str
Obrigatório

A ID do cliente do aplicativo

authorization_code
str
Obrigatório

O código de autorização do logon do usuário

redirect_uri
str
Obrigatório

O URI de redirecionamento do aplicativo. Deve corresponder ao URI usado para solicitar o código de autorização.

authority
str

Autoridade de um ponto de extremidade do Azure Active Directory, por exemplo, "login.microsoftonline.com", a autoridade para a Nuvem Pública do Azure (que é o padrão). AzureAuthorityHosts define autoridades para outras nuvens.

client_secret
str

Um dos segredos do cliente do aplicativo. Necessário apenas para aplicativos Web e APIs Web.

additionally_allowed_tenants
List[str]

Especifica locatários além do "tenant_id" especificado para o qual a credencial pode adquirir tokens. Adicione o valor curinga "*" para permitir que a credencial adquira tokens para qualquer locatário que o aplicativo possa acessar.

Exemplos

Crie um AuthorizationCodeCredential.


   from azure.identity.aio 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

Solicite um token de acesso para escopos.

Esse método é chamado automaticamente por clientes do SDK do Azure.

Na primeira vez que esse método for chamado, a credencial resgatará seu código de autorização. Em chamadas subsequentes, a credencial retornará um token de acesso armazenado em cache ou resgatará um token de atualização, se ele adquiriu um token de atualização ao resgatar o código de autorização.

close

Feche a sessão de transporte da credencial.

async close()

get_token

Solicite um token de acesso para escopos.

Esse método é chamado automaticamente por clientes do SDK do Azure.

Na primeira vez que esse método for chamado, a credencial resgatará seu código de autorização. Em chamadas subsequentes, a credencial retornará um token de acesso armazenado em cache ou resgatará um token de atualização, se ele adquiriu um token de atualização ao resgatar o código de autorização.

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

Parâmetros

scopes
str
Obrigatório

escopos desejados para o token de acesso. Esse método requer pelo menos um escopo. Para obter mais informações sobre escopos, consulte https://learn.microsoft.com/azure/active-directory/develop/scopes-oidc.

claims
str

declarações adicionais necessárias no token, como as retornadas no desafio de declarações de um provedor de recursos após uma falha de autorização.

tenant_id
str

locatário opcional a ser incluído na solicitação de token.

Retornos

Um token de acesso com os escopos desejados.

Tipo de retorno

AccessToken

Exceções

ClientAuthenticationError

falha na autenticação. O atributo do message erro fornece um motivo. Qualquer resposta de erro do Azure Active Directory está disponível como atributo do response erro.