Compartir a través de

DeviceCodeCredential class

  • Referencia
Paquete:
@azure/identity

Habilita la autenticación en el identificador de Entra de Microsoft mediante un código de dispositivo que el usuario puede escribir en https://microsoft.com/devicelogin.

Constructores

DeviceCodeCredential(DeviceCodeCredentialOptions)

Crea una instancia de DeviceCodeCredential con los detalles necesarios para iniciar el flujo de autorización del código de dispositivo con el identificador de Entra de Microsoft.

Se registrará un mensaje, lo que proporciona a los usuarios un código que pueden usar para autenticarse una vez que vayan a https://microsoft.com/devicelogin

Los desarrolladores pueden configurar cómo se muestra este mensaje pasando un userPromptCallbackpersonalizado:

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)

Se autentica con el identificador de Entra de Microsoft y devuelve un token de acceso si se ejecuta correctamente. Si se produce un error en la autenticación, se producirá una credentialUnavailableError con los detalles del error.

Si el token no se puede recuperar de forma silenciosa, este método siempre generará un desafío para el usuario.
getToken(string | string[], GetTokenOptions)

Se autentica con el identificador de Entra de Microsoft y devuelve un token de acceso si se ejecuta correctamente. Si se produce un error en la autenticación, se producirá una credentialUnavailableError con los detalles del error.

Si el usuario proporcionó la opción disableAutomaticAuthentication, una vez que el token no se pueda recuperar de forma silenciosa, este método no intentará solicitar la interacción del usuario para recuperar el token.

Detalles del constructor

DeviceCodeCredential(DeviceCodeCredentialOptions)

Crea una instancia de DeviceCodeCredential con los detalles necesarios para iniciar el flujo de autorización del código de dispositivo con el identificador de Entra de Microsoft.

Se registrará un mensaje, lo que proporciona a los usuarios un código que pueden usar para autenticarse una vez que vayan a https://microsoft.com/devicelogin

Los desarrolladores pueden configurar cómo se muestra este mensaje pasando un userPromptCallbackpersonalizado:

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

Opciones para configurar el cliente que realiza las solicitudes de autenticación.

Detalles del método

authenticate(string | string[], GetTokenOptions)

Se autentica con el identificador de Entra de Microsoft y devuelve un token de acceso si se ejecuta correctamente. Si se produce un error en la autenticación, se producirá una credentialUnavailableError con los detalles del error.

Si el token no se puede recuperar de forma silenciosa, este método siempre generará un desafío para el usuario.

function authenticate(scopes: string | string[], options?: GetTokenOptions): Promise<undefined | AuthenticationRecord>

Parámetros

scopes

string | string[]

Lista de ámbitos para los que el token tendrá acceso.

options
GetTokenOptions

Las opciones que se usan para configurar las solicitudes que puede realizar esta implementación de TokenCredential.

Devoluciones

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

Se autentica con el identificador de Entra de Microsoft y devuelve un token de acceso si se ejecuta correctamente. Si se produce un error en la autenticación, se producirá una credentialUnavailableError con los detalles del error.

Si el usuario proporcionó la opción disableAutomaticAuthentication, una vez que el token no se pueda recuperar de forma silenciosa, este método no intentará solicitar la interacción del usuario para recuperar el token.

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

Parámetros

scopes

string | string[]

Lista de ámbitos para los que el token tendrá acceso.

options
GetTokenOptions

Las opciones que se usan para configurar las solicitudes que puede realizar esta implementación de TokenCredential.

Devoluciones

Promise<AccessToken>