Partager via

DeviceCodeCredential class

  • Référence
Paquet:
@azure/identity

Active l’authentification auprès de Microsoft Entra ID à l’aide d’un code d’appareil que l’utilisateur peut entrer dans https://microsoft.com/devicelogin.

Constructeurs

DeviceCodeCredential(DeviceCodeCredentialOptions)

Crée une instance de DeviceCodeCredential avec les détails nécessaires pour lancer le flux d’autorisation du code d’appareil avec l’ID Microsoft Entra.

Un message est enregistré, ce qui donne aux utilisateurs un code qu’ils peuvent utiliser pour s’authentifier une fois qu’ils accèdent à https://microsoft.com/devicelogin

Les développeurs peuvent configurer la façon dont ce message est affiché en passant un userPromptCallbackpersonnalisé :

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éthodes

authenticate(string | string[], GetTokenOptions)

S’authentifie avec l’ID Microsoft Entra et retourne un jeton d’accès en cas de réussite. Si l’authentification échoue, une CredentialUnavailableError est levée avec les détails de l’échec.

Si le jeton ne peut pas être récupéré en mode silencieux, cette méthode génère toujours un défi pour l’utilisateur.
getToken(string | string[], GetTokenOptions)

S’authentifie avec l’ID Microsoft Entra et retourne un jeton d’accès en cas de réussite. Si l’authentification échoue, une CredentialUnavailableError est levée avec les détails de l’échec.

Si l’utilisateur a fourni l’option disableAutomaticAuthentication, une fois que le jeton ne peut pas être récupéré en mode silencieux, cette méthode ne tente pas de demander l’interaction de l’utilisateur pour récupérer le jeton.

Détails du constructeur

DeviceCodeCredential(DeviceCodeCredentialOptions)

Crée une instance de DeviceCodeCredential avec les détails nécessaires pour lancer le flux d’autorisation du code d’appareil avec l’ID Microsoft Entra.

Un message est enregistré, ce qui donne aux utilisateurs un code qu’ils peuvent utiliser pour s’authentifier une fois qu’ils accèdent à https://microsoft.com/devicelogin

Les développeurs peuvent configurer la façon dont ce message est affiché en passant un userPromptCallbackpersonnalisé :

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)

Paramètres

options
DeviceCodeCredentialOptions

Options de configuration du client qui effectue les demandes d’authentification.

Détails de la méthode

authenticate(string | string[], GetTokenOptions)

S’authentifie avec l’ID Microsoft Entra et retourne un jeton d’accès en cas de réussite. Si l’authentification échoue, une CredentialUnavailableError est levée avec les détails de l’échec.

Si le jeton ne peut pas être récupéré en mode silencieux, cette méthode génère toujours un défi pour l’utilisateur.

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

Paramètres

scopes

string | string[]

Liste des étendues auxquelles le jeton aura accès.

options
GetTokenOptions

Les options utilisées pour configurer toutes les demandes que cette implémentation TokenCredential peut effectuer.

Retours

Promise<undefined | AuthenticationRecord>

getToken(string | string[], GetTokenOptions)

S’authentifie avec l’ID Microsoft Entra et retourne un jeton d’accès en cas de réussite. Si l’authentification échoue, une CredentialUnavailableError est levée avec les détails de l’échec.

Si l’utilisateur a fourni l’option disableAutomaticAuthentication, une fois que le jeton ne peut pas être récupéré en mode silencieux, cette méthode ne tente pas de demander l’interaction de l’utilisateur pour récupérer le jeton.

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

Paramètres

scopes

string | string[]

Liste des étendues auxquelles le jeton aura accès.

options
GetTokenOptions

Les options utilisées pour configurer toutes les demandes que cette implémentation TokenCredential peut effectuer.

Retours

Promise<AccessToken>