Partilhar via


InteractiveBrowserCredential class

Permite a autenticação para o Microsoft Entra ID dentro do navegador da Web usando o fluxo de logon interativo.

Construtores

InteractiveBrowserCredential(InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

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

Essa credencial usa o Fluxo de Código de Autorização. No Node.js, ele abrirá uma janela do navegador enquanto escuta uma resposta de redirecionamento do serviço de autenticação. Nos navegadores, autentica-se através de pop-ups. O parâmetro opcional loginStyle pode ser definido como redirect para autenticar redirecionando o usuário para uma página de logon seguro do Azure, que redirecionará o usuário de volta para o aplicativo Web onde a autenticação começou.

Por Node.js, se um clientId for fornecido, o aplicativo Microsoft Entra precisará ser configurado para ter um ponto de extremidade de redirecionamento "Aplicativos móveis e de desktop". Siga nosso guia sobre configuração de URIs de redirecionamento para aplicativos da área de trabalho que chamam APIs da Web.

Métodos

authenticate(string | string[], GetTokenOptions)

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

Se o token não puder ser recuperado silenciosamente, esse método sempre gerará um desafio para o usuário.

No Node.js, essa credencial tem chave de prova para troca de código (PKCE) habilitada por padrão. PKCE é um recurso de segurança que atenua ataques de intercetação de código de autenticação.

getToken(string | string[], GetTokenOptions)

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

Se o usuário forneceu a opção disableAutomaticAuthentication, uma vez que o token não pode ser recuperado silenciosamente, esse método não tentará solicitar a interação do usuário para recuperar o token.

Detalhes do Construtor

InteractiveBrowserCredential(InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

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

Essa credencial usa o Fluxo de Código de Autorização. No Node.js, ele abrirá uma janela do navegador enquanto escuta uma resposta de redirecionamento do serviço de autenticação. Nos navegadores, autentica-se através de pop-ups. O parâmetro opcional loginStyle pode ser definido como redirect para autenticar redirecionando o usuário para uma página de logon seguro do Azure, que redirecionará o usuário de volta para o aplicativo Web onde a autenticação começou.

Por Node.js, se um clientId for fornecido, o aplicativo Microsoft Entra precisará ser configurado para ter um ponto de extremidade de redirecionamento "Aplicativos móveis e de desktop". Siga nosso guia sobre configuração de URIs de redirecionamento para aplicativos da área de trabalho que chamam APIs da Web.

new InteractiveBrowserCredential(options: InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions)

Parâmetros

options

InteractiveBrowserCredentialNodeOptions | InteractiveBrowserCredentialInBrowserOptions

Opções para configurar o cliente que faz as solicitações de autenticação.

Detalhes de Método

authenticate(string | string[], GetTokenOptions)

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

Se o token não puder ser recuperado silenciosamente, esse método sempre gerará um desafio para o usuário.

No Node.js, essa credencial tem chave de prova para troca de código (PKCE) habilitada por padrão. PKCE é um recurso de segurança que atenua ataques de intercetaçã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 escopos para os quais o token terá acesso.

options
GetTokenOptions

As opções usadas para configurar quaisquer solicitações que essa implementação de TokenCredential possa fazer.

Devoluções

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

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

Se o usuário forneceu a opção disableAutomaticAuthentication, uma vez que o token não pode ser recuperado silenciosamente, esse método não tentará solicitar a interação do usuário para recuperar o token.

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

Parâmetros

scopes

string | string[]

A lista de escopos para os quais o token terá acesso.

options
GetTokenOptions

As opções usadas para configurar quaisquer solicitações que essa implementação de TokenCredential possa fazer.

Devoluções

Promise<AccessToken>