DeviceCodeClient class
OAuth2.0 设备代码客户端
- 扩展
-
@azure/msal-common.BaseClient
方法
| acquire |
从设备代码终结点获取设备代码、使用设备代码响应回叫并轮询令牌终结点以交换令牌的设备代码 |
| create |
为设备代码请求创建查询字符串 |
继承的方法
| create |
为 /token 请求创建查询字符串 |
| send |
使用必要的预检和后检逻辑包装 sendPostRequestAsync |
| update |
更新客户端的颁发机构对象。 终结点发现必须完成。 |
构造函数详细信息
DeviceCodeClient(ClientConfiguration)
new DeviceCodeClient(configuration: ClientConfiguration)
参数
- configuration
- @azure/msal-common.ClientConfiguration
继承属性详细信息
authority
authority: Authority
属性值
继承自 BaseClient.authority
logger
方法详细信息
acquireToken(CommonDeviceCodeRequest)
从设备代码终结点获取设备代码、使用设备代码响应回叫并轮询令牌终结点以交换令牌的设备代码
function acquireToken(request: CommonDeviceCodeRequest): Promise<null | AuthenticationResult>
参数
- request
- CommonDeviceCodeRequest
开发人员提供的 CommonDeviceCodeRequest
返回
Promise<null | AuthenticationResult>
createExtraQueryParameters(CommonDeviceCodeRequest)
为设备代码请求创建查询字符串
function createExtraQueryParameters(request: CommonDeviceCodeRequest): string
参数
- request
- CommonDeviceCodeRequest
开发人员提供的 CommonDeviceCodeRequest
返回
string
继承的方法详细信息
createTokenQueryParameters(BaseAuthRequest)
为 /token 请求创建查询字符串
function createTokenQueryParameters(request: BaseAuthRequest): string
参数
- request
- BaseAuthRequest
返回
string
继承自 BaseClient.createTokenQueryParameters
sendPostRequest<T>(RequestThumbprint, string, NetworkRequestOptions, string)
使用必要的预检和后检逻辑包装 sendPostRequestAsync
function sendPostRequest<T>(thumbprint: RequestThumbprint, tokenEndpoint: string, options: NetworkRequestOptions, correlationId: string): Promise<NetworkResponse<T>>
参数
- thumbprint
- RequestThumbprint
请求限制指纹
- tokenEndpoint
-
string
将 POST 设置为的终结点
- options
- NetworkRequestOptions
要包含在 POST 请求中的正文和标头
- correlationId
-
string
遥测的 CorrelationId
返回
Promise<NetworkResponse<T>>
继承自 BaseClient.sendPostRequest
updateAuthority(string, string)
更新客户端的颁发机构对象。 终结点发现必须完成。
function updateAuthority(cloudInstanceHostname: string, correlationId: string): Promise<void>
参数
- cloudInstanceHostname
-
string
- correlationId
-
string
返回
Promise<void>
继承自 BaseClient.updateAuthority