Partilhar via

DeviceCodeCredential class

  • Referência
Pacote:
@azure/identity

Permite que a autenticação Microsoft Entra ID através de um código de dispositivo que o utilizador pode introduzir no https://microsoft.com/devicelogin.

Construtores

DeviceCodeCredential(DeviceCodeCredentialOptions)

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

Será registada uma mensagem, dando aos utilizadores um código que podem utilizar para autenticar assim que acederem a https://microsoft.com/devicelogin

Os programadores podem configurar a forma como esta mensagem é apresentada ao transmitir um 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 devolve um token de acesso se for bem-sucedido. Se a autenticação falhar, será apresentado 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.
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á apresentado um CredentialUnavailableError com os detalhes da falha.

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

Detalhes do Construtor

DeviceCodeCredential(DeviceCodeCredentialOptions)

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

Será registada uma mensagem, dando aos utilizadores um código que podem utilizar para autenticar assim que acederem a https://microsoft.com/devicelogin

Os programadores podem configurar a forma como esta mensagem é apresentada ao transmitir um 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 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á apresentado 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.

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á apresentado um CredentialUnavailableError com os detalhes da falha.

Se o utilizador tiver fornecido a opção disableAutomaticAuthentication, uma vez que o token não pode 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>