Compartilhar via

DeviceCodeCredential class

  • Referência
Pacote:
@azure/identity

Permite que a autenticação Microsoft Entra ID usando um código de dispositivo que o usuário pode inserir no 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 Microsoft Entra ID.

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

Os desenvolvedores podem configurar como essa mensagem é mostrada passando um personalizado userPromptCallback:

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

Métodos

authenticate(string | string[], GetTokenOptions)

Autentica com Microsoft Entra ID e retorna um token de acesso se tiver êxito. Se a autenticação falhar, um CredentialUnavailableError será lançado com os detalhes da falha.

Se o token não puder ser recuperado silenciosamente, esse método exigirá interação do usuário para recuperar o token.
getToken(string | string[], GetTokenOptions)

Autentica com Microsoft Entra ID e retorna um token de acesso se tiver êxito. Se a autenticação falhar, um CredentialUnavailableError será lançado com os detalhes da falha.

Se o usuário forneceu a opção disableAutomaticAuthentication, depois que o token não puder ser recuperado silenciosamente, esse método não tentará solicitar a 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 Microsoft Entra ID.

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

Os desenvolvedores podem configurar como essa mensagem é mostrada passando um personalizado userPromptCallback:

const credential = new DeviceCodeCredential({
  tenantId: env.AZURE_TENANT_ID,
  clientId: 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 Microsoft Entra ID e retorna um token de acesso se tiver êxito. Se a autenticação falhar, um CredentialUnavailableError será lançado com os detalhes da falha.

Se o token não puder ser recuperado silenciosamente, esse método exigirá interação do usuário para recuperar o token.

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.

Retornos

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

Autentica com Microsoft Entra ID e retorna um token de acesso se tiver êxito. Se a autenticação falhar, um CredentialUnavailableError será lançado com os detalhes da falha.

Se o usuário forneceu a opção disableAutomaticAuthentication, depois que o token não puder 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.

Retornos

Promise<AccessToken>