Partilhar via

ClientAssertionCredential Classe

  • Referência

Autentica um principal de serviço com uma asserção JWT.

Esta credencial destina-se a cenários avançados. CertificateCredential tem uma API mais conveniente para o cenário de asserção mais comum, autenticando um principal de serviço com um certificado.

Herança
azure.identity._internal.get_token_mixin.GetTokenMixin
ClientAssertionCredential

Construtor

ClientAssertionCredential(tenant_id: str, client_id: str, func: Callable[[], str], **kwargs: Any)

Parâmetros

tenant_id
str
Necessário

ID do inquilino do principal. Também denominado ID de "diretório".

client_id
str
Necessário

O ID de cliente do principal

func
Necessário

Um callable que devolve uma asserção de cadeia. A credencial chamará esta opção sempre que adquirir um novo token.

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.

additionally_allowed_tenants
List[str]

Especifica inquilinos para além do "tenant_id" especificado para o qual a credencial pode adquirir tokens. Adicione o valor de caráter universal "*" para permitir que a credencial adquira tokens para qualquer inquilino a que a aplicação possa aceder.

Exemplos

Crie um ClientAssertionCredential.


   from azure.identity import ClientAssertionCredential

   def get_assertion():
       return "<client-assertion>"

   credential = ClientAssertionCredential(
       tenant_id="<tenant_id>",
       client_id="<client_id>",
       func=get_assertion,
   )

Métodos

close
get_token

Pedir um token de acesso para âmbitos.

Este método é chamado automaticamente pelos clientes do SDK do Azure.

close 

close() -> None

get_token

Pedir um token de acesso para âmbitos.

Este método é chamado automaticamente pelos clientes do SDK do Azure.

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

Parâmetros

scopes
str
Necessário

â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 após uma falha de autorização.

tenant_id
str

inquilino opcional a incluir no pedido de token.

enable_cae
bool

indica se pretende ativar a Avaliação de Acesso Contínuo (CAE) para o token pedido. A predefinição é Falso.

Devoluções

Um token de acesso com os âmbitos pretendidos.

Tipo de retorno

AccessToken

Exceções

CredentialUnavailableError

a credencial não consegue tentar autenticação porque não tem os dados necessários, o estado ou o suporte da plataforma

ClientAuthenticationError

falha na autenticação. O atributo do message erro dá um motivo.