ClientAssertionCredential Classe

Autentica uma entidade de serviço com uma declaração JWT.

Essa credencial é para cenários avançados. CertificateCredential tem uma API mais conveniente para o cenário de declaração mais comum, autenticando uma entidade 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

Obrigatório

ID do locatário da entidade de segurança. Também chamou sua ID de "diretório".

client_id

str

Obrigatório

A ID do cliente da entidade de segurança

func

Obrigatório

Um callable que retorna uma asserção de cadeia de caracteres. A credencial chamará isso sempre que adquirir um novo token.

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 as autoridades para outras nuvens.

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 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	Solicite um token de acesso para escopos. Esse método é chamado automaticamente por clientes do SDK do Azure.

close

close() -> None

get_token

Solicite um token de acesso para escopos.

Esse método é chamado automaticamente por 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

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 aquelas 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.

enable_cae

bool

indica se a CAE (Avaliação Contínua de Acesso) deve ser habilitada para o token solicitado. Usa False como padrão.

Retornos

Um token de acesso com os escopos desejados.

Tipo de retorno

AccessToken

Exceções

CredentialUnavailableError

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

ClientAuthenticationError

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