Sdílet prostřednictvím

DeviceTokenCredentials class

Balíček:
@azure/ms-rest-nodeauth
Extends
TokenCredentialsBase

Konstruktory

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

Vytvoří nový objekt DeviceTokenCredentials, který získá nový přístupový token pomocí userCodeInfo (obsahuje user_code, device_code) pro ověřování uživatele na zařízení.

Při použití těchto přihlašovacích údajů skript poskytne adresu URL a kód. Uživatel musí zkopírovat adresu URL a kód, vložit ji do prohlížeče a ověřit ho tam. V případě úspěchu skript získá přístupový token.

Vlastnosti

username

Zděděné vlastnosti

authContext
clientId
domain
environment
tokenAudience
tokenCache

Metody

getToken()

Nejprve se pokusí získat token z mezipaměti. Pokud je to neúspěšné, pokusí se získat token z knihovny ADAL.

Zděděné metody

setDomain(string)
signRequest(WebResource)

Podepíše požadavek hlavičkou Ověřování.

Podrobnosti konstruktoru

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

Vytvoří nový objekt DeviceTokenCredentials, který získá nový přístupový token pomocí userCodeInfo (obsahuje user_code, device_code) pro ověřování uživatele na zařízení.

Při použití těchto přihlašovacích údajů skript poskytne adresu URL a kód. Uživatel musí zkopírovat adresu URL a kód, vložit ji do prohlížeče a ověřit ho tam. V případě úspěchu skript získá přístupový token.

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

Parametry

clientId

string

ID klienta aplikace služby Active Directory.

domain

string

ID domény nebo tenanta obsahující tuto aplikaci. Výchozí hodnota je "společná"

username

string

Uživatelské jméno pro účet ve formuláři: "user@example.com".

tokenAudience
TokenAudience

Cílová skupina, pro kterou je token požadován. Platné hodnoty jsou "graph", 'batch' nebo jakýkoli jiný prostředek, například 'https://vault.azure.net/'. Pokud je tokenAudience "graph", měla by se zadat také doména a její hodnota by neměla být výchozím tenantem "common". Musí to být řetězec (raději ve formátu GUID). Příklad najdete v rychlém startu služby Active Directory pro .Net.

environment
Environment

Prostředí Azure, ve které se má provést ověření. Výchozí prostředí je "Azure", které se často označuje jako "Veřejný cloud Azure".

tokenCache

TokenCache

Mezipaměť tokenů. Výchozí hodnota je MemoryCache objekt z adal.

Podrobnosti vlastnosti

username 

username: string

Hodnota vlastnosti

string

Podrobnosti zděděných vlastností

authContext 

authContext: AuthenticationContext

Hodnota vlastnosti

AuthenticationContext

zděděný zTokenCredentialsBase.authContext

clientId 

clientId: string

Hodnota vlastnosti

string

zděděný zTokenCredentialsBase.clientId

domain 

domain: string

Hodnota vlastnosti

string

zděděné ztokenCredentialsBase.domain

environment 

environment: Environment

Hodnota vlastnosti

Environment

zděděno zTokenCredentialsBase.environment

tokenAudience 

tokenAudience?: string

Hodnota vlastnosti

string

zděděno zTokenCredentialsBase.tokenAudience

tokenCache 

tokenCache: TokenCache

Hodnota vlastnosti

TokenCache

zděděné zTokenCredentialsBase.tokenCache

Podrobnosti metody

getToken()

Nejprve se pokusí získat token z mezipaměti. Pokud je to neúspěšné, pokusí se získat token z knihovny ADAL.

function getToken(): Promise<TokenResponse>

Návraty

Promise<TokenResponse>

TokenResponse (tokenType a accessToken jsou dvě důležité vlastnosti).

Podrobnosti zděděných metod

setDomain(string) 

function setDomain(domain: string)

Parametry

domain

string

zděděný zTokenCredentialsBase.setDomain

signRequest(WebResource)

Podepíše požadavek hlavičkou Ověřování.

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

Parametry

webResource
WebResource

WebResource, který se má podepsat.

Návraty

Promise<WebResource>

zděděno zTokenCredentialsBase.signRequest