DeviceTokenCredentials class

Extends

建構函式

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

建立新的 DeviceTokenCredentials 物件,該物件會使用 userCodeInfo 取得新的存取令牌(包含user_code,device_code),以驗證裝置上的使用者。

使用此認證時,腳本會提供URL和程序代碼。 用戶必須複製 URL 和程式碼、將它貼到瀏覽器中並在那裡進行驗證。 如果成功,腳本會取得存取令牌。

屬性

username

方法

getToken()

嘗試一開始從快取取得令牌。 如果失敗,則會嘗試從ADAL取得令牌。

繼承的方法

setDomain(string)
signRequest(WebResource)

使用驗證標頭簽署要求。

建構函式詳細資料

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

建立新的 DeviceTokenCredentials 物件,該物件會使用 userCodeInfo 取得新的存取令牌(包含user_code,device_code),以驗證裝置上的使用者。

使用此認證時,腳本會提供URL和程序代碼。 用戶必須複製 URL 和程式碼、將它貼到瀏覽器中並在那裡進行驗證。 如果成功,腳本會取得存取令牌。

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

參數

clientId

string

Active Directory 應用程式用戶端標識碼。

domain

string

包含此應用程式的網域或租用戶標識碼。 默認值為 “common”

username

string

帳戶的使用者名稱,格式為:“user@example.com”。

tokenAudience
TokenAudience

要求令牌的物件。 有效值為 'graph'、'batch' 或任何其他資源,例如 'https://vault.azure.net/'。 如果 tokenAudience 是 'graph',則也應該提供網域,而且其值不應該是預設的 'common' 租使用者。 它必須是字串(最好是 GUID 格式)。 如需範例,請參閱 .Net 的 Active Directory 快速入門。

environment
Environment

要驗證的 Azure 環境。 默認環境為「Azure」,通常稱為「公用 Azure 雲端」。

tokenCache

TokenCache

令牌快取。 預設值是 adal 中的 MemoryCache 物件。

屬性詳細資料

username

username: string

屬性值

string

繼承的屬性詳細資料

authContext

authContext: AuthenticationContext

屬性值

AuthenticationContext

繼承自TokenCredentialsBase.authContext

clientId

clientId: string

屬性值

string

繼承自TokenCredentialsBase.clientId

domain

domain: string

屬性值

string

繼承自TokenCredentialsBase.domain

environment

environment: Environment

屬性值

繼承自TokenCredentialsBase.environment

tokenAudience

tokenAudience?: string

屬性值

string

繼承自TokenCredentialsBase.tokenAudience

tokenCache

tokenCache: TokenCache

屬性值

TokenCache

繼承自TokenCredentialsBase.tokenCache

方法詳細資料

getToken()

嘗試一開始從快取取得令牌。 如果失敗,則會嘗試從ADAL取得令牌。

function getToken(): Promise<TokenResponse>

傳回

Promise<TokenResponse>

tokenResponse (tokenType 和 accessToken 是兩個重要屬性)。

繼承的方法的詳細資料

setDomain(string)

function setDomain(domain: string)

參數

domain

string

繼承自TokenCredentialsBase.setDomain

signRequest(WebResource)

使用驗證標頭簽署要求。

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

參數

webResource
WebResource

要簽署的 WebResource。

傳回

Promise<WebResource>

繼承自TokenCredentialsBase.signRequest