DeviceCodeCredential class
Hiermee schakelt u verificatie voor Microsoft Entra-id in met behulp van een apparaatcode die de gebruiker in https://microsoft.com/deviceloginkan invoeren.
Constructors
Device |
Hiermee maakt u een exemplaar van DeviceCodeCredential met de details die nodig zijn voor het initiëren van de autorisatiestroom voor apparaatcode met Microsoft Entra-id. Een bericht wordt geregistreerd en geeft gebruikers een code die ze kunnen gebruiken om zich te verifiëren zodra ze naar https://microsoft.com/devicelogin Ontwikkelaars kunnen configureren hoe dit bericht wordt weergegeven door een aangepaste
|
Methoden
authenticate(string | string[], Get |
Verifieert met Microsoft Entra-id en retourneert een toegangstoken als dit lukt. Als de verificatie mislukt, wordt een CredentialUnavailableError- gegenereerd met de details van de fout. Als het token niet op de achtergrond kan worden opgehaald, genereert deze methode altijd een uitdaging voor de gebruiker. |
get |
Verifieert met Microsoft Entra-id en retourneert een toegangstoken als dit lukt. Als de verificatie mislukt, wordt een CredentialUnavailableError- gegenereerd met de details van de fout. Als de gebruiker de optie |
Constructordetails
DeviceCodeCredential(DeviceCodeCredentialOptions)
Hiermee maakt u een exemplaar van DeviceCodeCredential met de details die nodig zijn voor het initiëren van de autorisatiestroom voor apparaatcode met Microsoft Entra-id.
Een bericht wordt geregistreerd en geeft gebruikers een code die ze kunnen gebruiken om zich te verifiëren zodra ze naar https://microsoft.com/devicelogin
Ontwikkelaars kunnen configureren hoe dit bericht wordt weergegeven door een aangepaste userPromptCallback
door te geven:
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)
Parameters
- options
- DeviceCodeCredentialOptions
Opties voor het configureren van de client waarmee de verificatieaanvragen worden ingediend.
Methodedetails
authenticate(string | string[], GetTokenOptions)
Verifieert met Microsoft Entra-id en retourneert een toegangstoken als dit lukt. Als de verificatie mislukt, wordt een CredentialUnavailableError- gegenereerd met de details van de fout.
Als het token niet op de achtergrond kan worden opgehaald, genereert deze methode altijd een uitdaging voor de gebruiker.
function authenticate(scopes: string | string[], options?: GetTokenOptions): Promise<undefined | AuthenticationRecord>
Parameters
- scopes
-
string | string[]
De lijst met bereiken waartoe het token toegang heeft.
- options
- GetTokenOptions
De opties die worden gebruikt voor het configureren van aanvragen die deze TokenCredential-implementatie mogelijk maakt.
Retouren
Promise<undefined | AuthenticationRecord>
getToken(string | string[], GetTokenOptions)
Verifieert met Microsoft Entra-id en retourneert een toegangstoken als dit lukt. Als de verificatie mislukt, wordt een CredentialUnavailableError- gegenereerd met de details van de fout.
Als de gebruiker de optie disableAutomaticAuthentication
heeft opgegeven, zal deze methode, zodra het token niet op de achtergrond kan worden opgehaald, niet proberen om gebruikersinteractie aan te vragen om het token op te halen.
function getToken(scopes: string | string[], options?: GetTokenOptions): Promise<AccessToken>
Parameters
- scopes
-
string | string[]
De lijst met bereiken waartoe het token toegang heeft.
- options
- GetTokenOptions
De opties die worden gebruikt voor het configureren van aanvragen die deze TokenCredential-implementatie mogelijk maakt.
Retouren
Promise<AccessToken>