Authok认证API
  1. 获取设备代码
Authok认证API
  • 登录
    • 社会化登录
      GET
    • 数据库/AD/LDAP登录
      GET
    • 企业级登录(SAML)
      GET
    • 免密登录
      POST
  • 多因素认证(MFA)
    • 发起多因素质询请求
      POST
    • 基于一次性密码(OTP)进行多因素认证(MFA)
      POST
    • 基于OOB进行多因素认证(MFA)
      POST
    • 基于Recovery Code进行MFA认证
      POST
    • 关联/添加新的认证器
      POST
    • 获取认证器列表
      GET
    • 删除认证器
      DELETE
  • SAML
    • 介绍
    • 接收SAML请求进行初始化登录
      GET
    • 获取元数据
      GET
    • IdP初始化的单点登录流程(SSO)
      POST
  • WS-Federation
    • 接收WS-Federation请求用于初始化登录
      GET
    • 获取 WS-Federation 元数据
      GET
  • 应用授权
    • 授权码流程
      GET
    • 授权码流程(PKCE)
      GET
    • 隐式流程
      GET
  • 获取设备代码
    • 获取设备代码
      POST
  • 获取令牌
    • 授权码流程
      POST
    • 授权码流程(PKCE)
      POST
    • 客户端凭证流程
      POST
    • 资源所有者密码
      POST
    • 设备授权流程
      POST
    • 刷新令牌
      POST
    • 本地社会化登录的令牌交换
      POST
  • 注销(Logout)
    GET
  • 通过邮件修改密码
    POST
  • 通过短信验证码修改密码
    POST
  • 获取用户详情
    GET
  • 动态应用注册
    POST
  • 撤销刷新令牌
    POST
  1. 获取设备代码

获取设备代码

POST
/oauth/device/code

请求参数

Body 参数application/json
audience
string 
必需
您想访问的目标API的唯一标识符
scope
string 
必需
要请求授权的作用域。多个作用域用空格隔开。您可以请求有关用户的任何标准OpenID Connect(OIDC)作用域,例如 profile 和 email、必须符合命名空间格式的自定义声明,或目标API支持的任何作用域(例如,read:contacts)。包括 offline_access 作用域可用于获取刷新令牌。
client_id
string 
应用ID
必需
示例
{
  "audience": "https://order/api/v1/",
  "scope": "read:orders create:orders update:orders delete:orders",
  "client_id": "KuGXglL6f5JT4dA2f9nLyuWbc7Q64dbR"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://127.0.0.1/oauth/device/code' \
--header 'Content-Type: application/json' \
--data-raw '{
    "audience": "https://order/api/v1/",
    "scope": "read:orders create:orders update:orders delete:orders",
    "client_id": "KuGXglL6f5JT4dA2f9nLyuWbc7Q64dbR"
}'

返回响应

🟢200成功
application/json
Body
device_code
string 
设备代码
必需
设备代码
user_code
string 
用户代码
必需
用户代码
verification_uri
string 
验证uri
必需
用户访问此URL进行设备授权
verification_uri_complete
string 
必需
授权设备的完整URL。URL中可嵌入 user_code
expires_in
integer 
必需
device_code 和 user_code 的生命周期 (秒)
interval
integer 
必需
应用应轮询令牌URL以请求令牌的间隔(秒)
示例
{
  "device_code": "Lwzo070KPyypnmSn5il58GlTM8hSaAxe",
  "user_code": "PzqoDlxZ9UN87CAtaZAv23cbDVydkTfV",
  "verification_uri": "https://YOUR_DOMAIN/device",
  "verification_uri_complete": "https://YOUR_DOMAIN/device?user_code=PzqoDlxZ9UN87CAtaZAv23cbDVydkTfV",
  "expires_in": 900,
  "interval": 10
}
修改于 2022-03-19 19:16:18
上一页
隐式流程
下一页
授权码流程
Built with