InteractiveBrowserCredential Classe

Abre um navegador para autenticar interativamente um usuário.

get_token abre um navegador para uma URL de logon fornecida pelo Azure Active Directory e autentica um usuário lá com o fluxo de código de autorização, usando o PKCE (Chave de Prova para Troca de Código) 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 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.

tenant_id

str

uma ID de locatário do Azure Active Directory. O padrão é o locatário "organizações", que pode autenticar contas corporativas ou de estudante.

client_id

str

A ID do cliente dos usuários do aplicativo do Azure Active Directory entrará. Se não for especificado, os usuários serão autenticados em um aplicativo de desenvolvimento do Azure.

login_hint

str

uma sugestão de nome de usuário para preencher previamente o campo nome de usuário/endereço de email da página de logon. Um usuário ainda pode fazer logon com um nome de usuário diferente.

redirect_uri

str

um URI de redirecionamento para o aplicativo identificado por client_id conforme configurado no Azure Active Directory, por exemplo, "http://localhost:8400". Isso só é necessário ao passar um valor para client_id e deve corresponder a um URI de redirecionamento no registro do aplicativo. A credencial deve ser capaz de associar um soquete a esse URI.

authentication_record

AuthenticationRecord

AuthenticationRecord retornado por authenticate

disable_automatic_authentication

bool

se True, get_token aumentará AuthenticationRequiredError quando a interação do usuário for necessária para adquirir um token. Usa False como padrão.

cache_persistence_options

TokenCachePersistenceOptions

configuração para cache de token persistente. Se não for especificado, a credencial armazenará tokens em cache na memória.

timeout

int

segundos para aguardar até que o usuário conclua a autenticação. O padrão é 300 (5 minutos).

disable_instance_discovery

bool

Determina se a descoberta de instância é executada ou não ao tentar se autenticar. Definir isso como true desabilitará completamente a descoberta de instância e a validação de autoridade. Essa funcionalidade destina-se ao uso em cenários em que o ponto de extremidade de metadados não pode ser alcançado, como em nuvens privadas ou no Azure Stack. O processo de descoberta de instância envolve a recuperação de metadados de autoridade de https://login.microsoft.com/ para validar a autoridade. Ao definir isso como True, a validação da autoridade é desabilitada. Como resultado, é crucial garantir que o host de autoridade configurado seja válido e confiável.

Exemplos

Crie um InteractiveBrowserCredential.

   from azure.identity import InteractiveBrowserCredential

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

Métodos

authenticate	Autenticar interativamente um usuário.
close
get_token	Solicite um token de acesso para escopos. Esse método é chamado automaticamente por clientes do SDK do Azure.

authenticate

Autenticar interativamente um usuário.

authenticate(**kwargs: Any) -> AuthenticationRecord

Parâmetros

scopes

Iterable[str]

escopos a serem solicitados durante a autenticação, como aqueles fornecidos por scopes. Se fornecida, a autenticação bem-sucedida armazenará em cache um token de acesso para esses escopos.

claims

str

declarações adicionais necessárias no token, como as fornecidas por claims

Tipo de retorno

AuthenticationRecord

Exceções

ClientAuthenticationError

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

close

close() -> None

Exceções

ClientAuthenticationError

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

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 pode tentar a autenticação porque não tem dados, estado ou suporte à plataforma necessários

ClientAuthenticationError

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

AuthenticationRequiredError

A interação do usuário é necessária para adquirir um token e a credencial está configurada para não iniciar isso automaticamente. Chamar

authenticate

para iniciar a autenticação interativa.