DeviceCodeCredential class
Habilita a autenticação para o Microsoft Entra ID usando um código de dispositivo que o usuário pode inserir no https://microsoft.com/devicelogin.
Construtores
Device |
Cria uma instância de DeviceCodeCredential com os detalhes necessários para iniciar o fluxo de autorização de código de dispositivo com o Microsoft Entra ID. Uma mensagem será registrada, 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 um
|
Métodos
authenticate(string | string[], Get |
Autentica com o ID do Microsoft Entra e retorna um token de acesso se for bem-sucedido.
Se a autenticação falhar, uma CredentialUnavailableError Se o token não puder ser recuperado silenciosamente, esse método sempre gerará um desafio para o usuário. |
get |
Autentica com o ID do Microsoft Entra e retorna um token de acesso se for bem-sucedido.
Se a autenticação falhar, uma CredentialUnavailableError Se o usuário forneceu a opção |
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 de dispositivo com o Microsoft Entra ID.
Uma mensagem será registrada, 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 um userPromptCallback
personalizado:
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 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
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 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
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>