DeviceTokenCredentials class

包:

@azure/ms-rest-nodeauth

扩展

TokenCredentialsBase

构造函数

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

创建一个新的 DeviceTokenCredentials 对象，该对象使用 userCodeInfo（包含user_code，device_code）获取新的访问令牌，以便在设备上对用户进行身份验证。 使用此凭据时，脚本将提供 URL 和代码。 用户需要复制 URL 和代码，将其粘贴到浏览器中，并在其中进行身份验证。 如果成功，脚本将获取访问令牌。

属性

username

继承属性

authContext
clientId
domain
environment
tokenAudience
tokenCache

方法

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 应用程序客户端 ID。

domain

string

包含此应用程序的域或租户 ID。 默认值为“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

属性值

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