UsernamePasswordCredential Classe

Autentica um utilizador com um nome de utilizador e palavra-passe.

Em geral, a Microsoft não recomenda este tipo de autenticação, porque é menos segura do que outros fluxos de autenticação.

A autenticação com esta credencial não é interativa, pelo que não é compatível com qualquer forma de autenticação multifator ou pedido de consentimento. A aplicação já tem de ter consentimento do utilizador ou de um administrador de diretórios.

Esta credencial só pode autenticar contas escolares e profissionais; As contas Microsoft não são suportadas. Veja a documentação do Azure Active Directory para obter mais informações sobre os tipos de conta.

Herança

azure.identity._internal.interactive.InteractiveCredential

UsernamePasswordCredential

Construtor

UsernamePasswordCredential(client_id: str, username: str, password: str, **kwargs: Any)

Parâmetros

client_id

str

Necessário

O ID de cliente da aplicação

username

str

Necessário

O nome de utilizador do utilizador (normalmente um endereço de e-mail)

password

str

Necessário

A palavra-passe do utilizador

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.

tenant_id

str

ID do inquilino ou um domínio associado a um inquilino. Se não for fornecido, a predefinição é o inquilino "organizações", que suporta apenas contas escolares ou profissionais do Azure Active Directory.

cache_persistence_options

TokenCachePersistenceOptions

Configuração para colocação em cache de tokens persistentes. Se não for especificado, a credencial colocará os tokens em cache na memória.

disable_instance_discovery

bool

Determina se a deteção de instâncias é ou não efetuada ao tentar autenticar. Definir isto como verdadeiro irá desativar completamente a deteção de instâncias e a validação da autoridade. Esta funcionalidade destina-se a ser utilizada em cenários em que não é possível alcançar o ponto final de metadados, como em clouds privadas ou no Azure Stack. O processo de deteção de instâncias implica a obtenção de metadados de autoridade de https://login.microsoft.com/ para validar a autoridade. Ao defini-lo como Verdadeiro, a validação da autoridade está desativada. Como resultado, é crucial garantir que o anfitrião de autoridade configurado é válido e fidedigno.

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

   from azure.identity import UsernamePasswordCredential

   credential = UsernamePasswordCredential(
       client_id="<client_id>",
       username="<username>",
       password="<password>",
   )

Métodos

authenticate	Autenticar interativamente um utilizador.
close
get_token	Pedir um token de acesso para âmbitos. Este método é chamado automaticamente pelos clientes do SDK do Azure.

authenticate

Autenticar interativamente um utilizador.

authenticate(**kwargs: Any) -> AuthenticationRecord

Parâmetros

scopes

Iterable[str]

âmbitos a pedir durante a autenticação, tais como os fornecidos pelo scopes. Se for fornecida, a autenticação bem-sucedida colocará em cache um token de acesso para estes âmbitos.

claims

str

afirmações adicionais necessárias no token, tais como as fornecidas pelo claims

Tipo de retorno

AuthenticationRecord

Exceções

ClientAuthenticationError

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

close

close() -> None

Exceções

ClientAuthenticationError

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

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.

AuthenticationRequiredError

A interação do utilizador é necessária para adquirir um token e a credencial está configurada para não iniciar isto automaticamente. Chamada

authenticate

para iniciar a autenticação interativa.