Compartilhar via

DeviceCodeCredential class

  • Referência
Pacote:
@azure/identity

Habilita a autenticação para a ID do Microsoft Entra usando um código de dispositivo que o usuário pode inserir em https://microsoft.com/devicelogin.

Construtores

DeviceCodeCredential(DeviceCodeCredentialOptions)

Cria uma instância de DeviceCodeCredential com os detalhes necessários para iniciar o fluxo de autorização de código do dispositivo com a ID do Microsoft Entra.

Uma mensagem será registrada em log, dando aos usuários um código que eles podem usar para autenticar quando forem para https://microsoft.com/devicelogin

Os desenvolvedores podem configurar como essa mensagem é mostrada passando uma userPromptCallbackpersonalizada:

import { DeviceCodeCredential } from "@azure/identity";

const credential = new DeviceCodeCredential({
  tenantId: process.env.AZURE_TENANT_ID,
  clientId: process.env.AZURE_CLIENT_ID,
  userPromptCallback: (info) => {
    console.log("CUSTOMIZED PROMPT CALLBACK", info.message);
  },
});

Métodos

authenticate(string | string[], GetTokenOptions)

Autentica com a ID do Microsoft Entra e retorna um token de acesso se bem-sucedido. Se a autenticação falhar, um CredentialUnavailableError será gerado 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.
getToken(string | string[], GetTokenOptions)

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

Se o usuário tiver fornecido a opção disableAutomaticAuthentication, depois que o token não puder ser recuperado silenciosamente, esse método não tentará solicitar interação do usuário para recuperar o token.

Detalhes do construtor

DeviceCodeCredential(DeviceCodeCredentialOptions)

Cria uma instância de DeviceCodeCredential com os detalhes necessários para iniciar o fluxo de autorização de código do dispositivo com a ID do Microsoft Entra.

Uma mensagem será registrada em log, dando aos usuários um código que eles podem usar para autenticar quando forem para https://microsoft.com/devicelogin

Os desenvolvedores podem configurar como essa mensagem é mostrada passando uma userPromptCallbackpersonalizada:

import { DeviceCodeCredential } from "@azure/identity";

const credential = new DeviceCodeCredential({
  tenantId: process.env.AZURE_TENANT_ID,
  clientId: process.env.AZURE_CLIENT_ID,
  userPromptCallback: (info) => {
    console.log("CUSTOMIZED PROMPT CALLBACK", info.message);
  },
});

new DeviceCodeCredential(options?: DeviceCodeCredentialOptions)

Parâmetros

options
DeviceCodeCredentialOptions

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

Detalhes do método

authenticate(string | string[], GetTokenOptions)

Autentica com a ID do Microsoft Entra e retorna um token de acesso se bem-sucedido. Se a autenticação falhar, um CredentialUnavailableError será gerado 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.

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 as solicitações que essa implementação do TokenCredential pode fazer.

Retornos

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

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

Se o usuário tiver fornecido a opção disableAutomaticAuthentication, depois que o token não puder ser recuperado silenciosamente, esse método não tentará solicitar 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 as solicitações que essa implementação do TokenCredential pode fazer.

Retornos

Promise<AccessToken>