更新时间:2024-04-10 GMT+08:00

请求设备授权

功能介绍

发起设备授权请求。

URI

POST /v1/device/authorize

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

client_id

String

在IAM身份中心注册的客户端的唯一标识符。

client_secret

String

为客户端生成的秘密字符串。客户端将使用此字符串在后续调用中获得服务的身份验证。

start_url

String

用户门户的URL。

响应参数

状态码: 200

表2 响应Body参数

参数

参数类型

描述

device_code

String

设备在轮询会话令牌时使用的设备码。

expires_in

Integer

设备码失效时间(以秒为单位)。

interval

Integer

指示轮询会话时,客户端在两次尝试之间必须等待的秒数。

user_code

String

一次性用户验证码。授权正在使用的设备时需要此操作。

verification_uri

String

使用一次性用户验证码授权设备的验证页面的URI。

verification_uri_complete

String

客户端可用于自动启动浏览器的备用URL。此过程跳过用户访问验证页面并输入代码的手动步骤。

请求示例

请求设备授权。

POST https://{hostname}/v1/device/authorize

{
  "client_id" : "example_client_id",
  "client_secret" : "example_client_secret",
  "start_url" : "https://example-start.example.com/start/url"
}

响应示例

状态码: 200

Successful

{
  "device_code" : "1234567890123456789012345678901234567890123456789012345678901234",
  "expires_in" : 1684955360,
  "interval" : 10,
  "user_code" : "1234567890123456",
  "verification_uri" : "https://example-erification.example.com/erification/url",
  "verification_uri_complete" : "https://example-erification-complete.example.com/erification/url"
}

状态码

请参见状态码

错误码

请参见错误码