Partilhar via


InteractiveBrowserCredential class

Permite que a autenticação Microsoft Entra ID dentro do browser com o fluxo de início de sessão interativo.

Construtores

InteractiveBrowserCredential(InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

Cria uma instância do InteractiveBrowserCredential com os detalhes necessários.

Esta credencial utiliza o Fluxo de Código de Autorização. No Node.js, abrirá uma janela do browser enquanto escuta uma resposta de redirecionamento do serviço de autenticação. Nos browsers, autentica-se através de pop-ups. O loginStyle parâmetro opcional pode ser definido para redirect autenticar ao redirecionar o utilizador para uma página de início de sessão seguro do Azure, que redirecionará o utilizador novamente para a aplicação Web onde a autenticação foi iniciada.

Para Node.js, se for fornecido umclientId, a aplicação Microsoft Entra terá de ser configurada para ter um ponto final de redirecionamento "Aplicações móveis e de ambiente de trabalho". Siga o nosso guia sobre como configurar URIs de Redirecionamento para aplicações de Ambiente de Trabalho que chamam apIs Web.

Métodos

authenticate(string | string[], GetTokenOptions)

Autentica com Microsoft Entra ID e devolve um token de acesso se for bem-sucedido. Se a autenticação falhar, será emitido um CredentialUnavailableError com os detalhes da falha.

Se não for possível obter o token automaticamente, este método exigirá a interação do utilizador para obter o token.

No Node.js, esta credencial tem a Chave de Prova para o Code Exchange (PKCE) ativada por predefinição. O PKCE é uma funcionalidade de segurança que mitiga ataques de intercepção de código de autenticação.

getToken(string | string[], GetTokenOptions)

Autentica com Microsoft Entra ID e devolve um token de acesso se for bem-sucedido. Se a autenticação falhar, será emitido um CredentialUnavailableError com os detalhes da falha.

Se o utilizador tiver fornecido a opção disableAutomaticAuthentication, uma vez que o token não possa ser obtido automaticamente, este método não tentará pedir a interação do utilizador para obter o token.

Detalhes do Construtor

InteractiveBrowserCredential(InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

Cria uma instância do InteractiveBrowserCredential com os detalhes necessários.

Esta credencial utiliza o Fluxo de Código de Autorização. No Node.js, abrirá uma janela do browser enquanto escuta uma resposta de redirecionamento do serviço de autenticação. Nos browsers, autentica-se através de pop-ups. O loginStyle parâmetro opcional pode ser definido para redirect autenticar ao redirecionar o utilizador para uma página de início de sessão seguro do Azure, que redirecionará o utilizador novamente para a aplicação Web onde a autenticação foi iniciada.

Para Node.js, se for fornecido umclientId, a aplicação Microsoft Entra terá de ser configurada para ter um ponto final de redirecionamento "Aplicações móveis e de ambiente de trabalho". Siga o nosso guia sobre como configurar URIs de Redirecionamento para aplicações de Ambiente de Trabalho que chamam apIs Web.

new InteractiveBrowserCredential(options: InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

Parâmetros

options

InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions

Opções para configurar o cliente que faz os pedidos de autenticação.

Detalhes de Método

authenticate(string | string[], GetTokenOptions)

Autentica com Microsoft Entra ID e devolve um token de acesso se for bem-sucedido. Se a autenticação falhar, será emitido um CredentialUnavailableError com os detalhes da falha.

Se não for possível obter o token automaticamente, este método exigirá a interação do utilizador para obter o token.

No Node.js, esta credencial tem a Chave de Prova para o Code Exchange (PKCE) ativada por predefinição. O PKCE é uma funcionalidade de segurança que mitiga ataques de intercepção de código de autenticação.

function authenticate(scopes: string | string[], options?: GetTokenOptions): Promise<undefined | AuthenticationRecord>

Parâmetros

scopes

string | string[]

A lista de âmbitos aos quais o token terá acesso.

options
GetTokenOptions

As opções utilizadas para configurar quaisquer pedidos que esta implementação TokenCredential possa fazer.

Devoluções

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

Autentica com Microsoft Entra ID e devolve um token de acesso se for bem-sucedido. Se a autenticação falhar, será emitido um CredentialUnavailableError com os detalhes da falha.

Se o utilizador tiver fornecido a opção disableAutomaticAuthentication, uma vez que o token não possa ser obtido automaticamente, este método não tentará pedir a interação do utilizador para obter o token.

function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>

Parâmetros

scopes

string | string[]

A lista de âmbitos aos quais o token terá acesso.

options
GetTokenOptions

As opções utilizadas para configurar quaisquer pedidos que esta implementação TokenCredential possa fazer.

Devoluções

Promise<AccessToken>