Freigeben über


DeviceTokenCredentials class

Extends

Konstruktoren

DeviceTokenCredentials(string, string, string, TokenAudience, Environment, TokenCache)

Erstellt ein neues DeviceTokenCredentials -Objekt, das ein neues Zugriffstoken mithilfe von userCodeInfo (enthält user_code, device_code) zum Authentifizieren von Benutzern auf dem Gerät abruft.

Wenn diese Anmeldeinformationen verwendet werden, stellt das Skript eine URL und einen Code bereit. Der Benutzer muss die URL und den Code kopieren, in einen Browser einfügen und sich dort authentifizieren. Bei erfolgreicher Ausführung erhält das Skript das Zugriffstoken.

Eigenschaften

username

Geerbte Eigenschaften

authContext
clientId
domain
environment
tokenAudience
tokenCache

Methoden

getToken()

Versucht, das Token anfänglich aus dem Cache abzurufen. Wenn dies nicht erfolgreich ist, versucht sie, das Token von ADAL abzurufen.

Geerbte Methoden

setDomain(string)
signRequest(WebResource)

Signiert eine Anforderung mit dem Authentifizierungsheader.

Details zum Konstruktor

DeviceTokenCredentials(string, string, string, TokenAudience, Environment, TokenCache)

Erstellt ein neues DeviceTokenCredentials -Objekt, das ein neues Zugriffstoken mithilfe von userCodeInfo (enthält user_code, device_code) zum Authentifizieren von Benutzern auf dem Gerät abruft.

Wenn diese Anmeldeinformationen verwendet werden, stellt das Skript eine URL und einen Code bereit. Der Benutzer muss die URL und den Code kopieren, in einen Browser einfügen und sich dort authentifizieren. Bei erfolgreicher Ausführung erhält das Skript das Zugriffstoken.

new DeviceTokenCredentials(clientId?: string, domain?: string, username?: string, tokenAudience?: TokenAudience, environment?: Environment, tokenCache?: TokenCache)

Parameter

clientId

string

Die Client-ID der Active Directory-Anwendung.

domain

string

Die Domänen- oder Mandanten-ID, die diese Anwendung enthält. Standardwert ist "common"

username

string

Der Benutzername für das Konto im Formular: "user@example.com".

tokenAudience
TokenAudience

Die Zielgruppe, für die das Token angefordert wird. Gültige Werte sind "graph", "batch" oder eine andere Ressource wie "https://vault.azure.net/". Wenn tokenAudience "graph" ist, sollte auch die Domäne angegeben werden, und ihr Wert sollte nicht der standardmäßige "gemeinsame" Mandant sein. Es muss sich um eine Zeichenfolge (bevorzugt in einem GUID-Format) sein. Ein Beispiel finden Sie unter Active Directory-Schnellstart für .Net-.

environment
Environment

Die azure-Umgebung, mit der sich authentifiziert werden soll. Die Standardumgebung ist "Azure" bekannt als "Public Azure Cloud".

tokenCache

TokenCache

Der Tokencache. Der Standardwert ist das MemoryCache-Objekt von adal.

Details zur Eigenschaft

username

username: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

authContext

authContext: AuthenticationContext

Eigenschaftswert

AuthenticationContext

geerbt vonTokenCredentialsBase.authContext-

clientId

clientId: string

Eigenschaftswert

string

vonTokenCredentialsBase.clientId geerbt

domain

domain: string

Eigenschaftswert

string

vonTokenCredentialsBase.domain geerbt

environment

environment: Environment

Eigenschaftswert

vonTokenCredentialsBase.environment geerbt

tokenAudience

tokenAudience?: string

Eigenschaftswert

string

vonTokenCredentialsBase.tokenAudience geerbt

tokenCache

tokenCache: TokenCache

Eigenschaftswert

TokenCache

vonTokenCredentialsBase.tokenCache geerbt

Details zur Methode

getToken()

Versucht, das Token anfänglich aus dem Cache abzurufen. Wenn dies nicht erfolgreich ist, versucht sie, das Token von ADAL abzurufen.

function getToken(): Promise<TokenResponse>

Gibt zurück

Promise<TokenResponse>

TokenResponse (tokenType und accessToken sind die beiden wichtigen Eigenschaften).

Details zur geerbten Methode

setDomain(string)

function setDomain(domain: string)

Parameter

domain

string

geerbt vonTokenCredentialsBase.setDomain-

signRequest(WebResource)

Signiert eine Anforderung mit dem Authentifizierungsheader.

function signRequest(webResource: WebResource): Promise<WebResource>

Parameter

webResource
WebResource

Die zu signierte WebResource.

Gibt zurück

Promise<WebResource>

geerbt vonTokenCredentialsBase.signRequest-