InteractiveBrowserCredential Classe

Abre um browser para autenticar interativamente um utilizador.

get_token abre um browser para um URL de início de sessão fornecido pelo Azure Active Directory e autentica um utilizador no mesmo com o fluxo de código de autorização, utilizando o PKCE (Chave de Prova para o Code Exchange) internamente para proteger o código.

Herança

azure.identity._internal.interactive.InteractiveCredential

InteractiveBrowserCredential

Construtor

InteractiveBrowserCredential(**kwargs: Any)

Parâmetros

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

um ID de inquilino do Azure Active Directory. A predefinição é o inquilino "organizações", que pode autenticar contas escolares ou profissionais.

client_id

str

O ID de cliente dos utilizadores da aplicação do Azure Active Directory iniciará sessão. Se não for especificado, os utilizadores serão autenticados numa aplicação de desenvolvimento do Azure.

login_hint

str

uma sugestão de nome de utilizador para pré-preencher o campo nome de utilizador/endereço de e-mail da página de início de sessão. Um utilizador ainda pode iniciar sessão com um nome de utilizador diferente.

redirect_uri

str

um URI de redirecionamento para a aplicação identificado pelo client_id como configurado no Azure Active Directory, por exemplo "http://localhost:8400". Isto só é necessário ao transmitir um valor para client_id e tem de corresponder a um URI de redirecionamento no registo da aplicação. A credencial tem de conseguir vincular um socket a este URI.

authentication_record

AuthenticationRecord

AuthenticationRecord devolvido por authenticate

disable_automatic_authentication

bool

se For Verdadeiro, get_token será gerado AuthenticationRequiredError quando a interação do utilizador for necessária para adquirir um token. A predefinição é Falso.

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.

timeout

int

segundos para aguardar que o utilizador conclua a autenticação. A predefinição é 300 (5 minutos).

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.

Exemplos

Crie um InteractiveBrowserCredential.

   from azure.identity import InteractiveBrowserCredential

   credential = InteractiveBrowserCredential(
       client_id="<client_id>",
   )

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.