Authok管理API
  1. 资源服务器(ResourceServer)
Authok管理API
  • 快速开始
    • 获取Token
  • 身份源(Connection)
    • 创建身份源
      POST
    • 根据ID查找身份源
      GET
    • 更新身份源
      PATCH
    • 删除身份源
      DELETE
    • 获取身份源列表
      GET
    • 获取身份源的状态
      GET
    • 删除身份源的给定用户
      DELETE
  • 应用(Client)
    • 查找应用
      GET
    • 创建应用
      POST
    • 更新应用
      PATCH
    • 删除应用
      DELETE
    • 获取应用列表
      GET
    • 轮换密钥
      POST
  • 资源服务器(ResourceServer)
    • 创建资源服务器
      POST
    • 获取资源服务器
      GET
    • 更新资源服务器
      PATCH
    • 删除资源服务器
      DELETE
    • 获取资源服务器列表
      GET
  • 用户(User)
    • 创建用户
      POST
    • 获取用户详情
      GET
    • 修改用户详情
      PATCH
    • 删除用户
      DELETE
    • 分页查找用户
      GET
    • 给用户添加权限
      POST
    • 删除用户的权限
      DELETE
    • 获取用户的权限列表
      GET
    • 获取用户的角色列表
      GET
    • 给用户添加角色
      POST
    • 删除用户的角色
      DELETE
    • 关联用户
      POST
    • 解除用户关联
      DELETE
    • 获取用户所在的组织列表
      GET
  • 角色(Role)
    • 创建角色
    • 获取角色信息
    • 更新角色信息
    • 删除角色
    • 获取角色列表
    • 获取角色的权限列表
    • 删除角色的权限
    • 分配权限给角色
    • 获取角色的用户列表
    • 分配角色给用户
    • 从给定角色中移除用户
  • 分组(Group)
  • 租户(Tenant)
    • 获取当前租户详情
    • 修改租户详情
  • 组织(Organization)
    • 创建组织
    • 获取组织详情
    • 更新组织
    • 删除组织
    • 获取组织列表
    • 根据标识符查找组织
    • 获取组织开启的身份源
    • 获取组织的成员列表
    • 从组织中删除成员
    • 添加成员到组织
    • 获取组织的邀请列表
    • 创建邀请
    • 获取邀请详情
    • 删除邀请
    • 获取组织开启的身份源列表
    • 给组织添加身份源
    • 获取组织开启的身份源详情
    • 从组织中删除给定的身份源
    • 修改组织关联的身份源配置
    • 获取成员关联的角色列表
  • 动作(Action)
    • 创建动作
    • 获取动作列表
    • 更新动作
    • 删除动作
    • 测试动作
    • 获取触发器列表
    • 获取触发器/动作绑定列表
    • 更新触发器/动作绑定
  • 授权(Grant)
  • 应用授权(ClientGrant)
    • 创建应用授权
    • 查找应用授权
    • 更新应用授权
    • 删除应用授权
    • 获取应用授权列表
  • 日志(Log)
  • 自定义域名(CusomDomain)
    • 创建自定义域名
    • 获取自定义域名
    • 更新自定义域名
    • 删除自定义域名
    • 获取自定义域名列表
    • 验证自定义域名
  • 密钥(Key)
    • 获取应用的所有密钥列表
    • 根据ID获取给定密钥
    • 轮换密钥
    • 撤销密钥
  • 任务(Job)
  • 多因素认证(MFA)
  • 安全防护(AttackProtection)
  • 品牌化(Branding)
  1. 资源服务器(ResourceServer)

获取资源服务器

开发中
GET
/api/v1/resource-servers/{id}
资源服务器

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Path 参数
id
string 
资源服务器ID
必需
示例值:
Z9t1bqKrBSuKAtKbtCcbWGXkb3NSb-Nl

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://..authok.cn/api/v1/resource-servers/Z9t1bqKrBSuKAtKbtCcbWGXkb3NSb-Nl'

返回响应

🟢200成功
application/json
Body
id
string 
必需
name
string 
名称
必需
名称
identifier
string 
唯一标识符
必需
唯一标识符, 对应 audience
is_system
boolean 
是否系统API
必需
是否系统API
scopes
array[object (Scope) {2}] 
权限
必需
权限
value
string 
必需
description
string 
必需
signing_alg
string 
签名算法
必需
签名算法
signing_secret
string 
签名密钥
必需
签名密钥
allow_offline_access
boolean 
是否允许离线访问
必需
是否允许离线访问
skip_consent_for_verifiable_first_party_clients
boolean 
是否跳过第一方应用的授权提示
必需
是否跳过第一方应用的授权提示
token_lifetime
integer 
令牌有效期
必需
令牌有效期
token_lifetime_for_web
integer 
令牌有效期(web端)
必需
令牌有效期(web端)
enforce_policies
boolean 
是否启用RBAC策略
必需
是否启用RBAC策略, 启用后权限会写入令牌
token_dialect
string 
令牌dialect
必需
令牌dialect
示例
{
  "id": "Z9t1bqKrBSuKAtKbtCcbWGXkb3NSb-Nl",
  "name": "订单API",
  "identifier": "https://order.mydomain/api/v1/",
  "scopes": [
    {
      "value": "read:orders",
      "description": "读取订单"
    },
    {
      "value": "update:orders",
      "description": "更新订单"
    },
    {
      "value": "create:orders",
      "description": "创建订单"
    },
    {
      "value": "delete:orders",
      "description": "删除订单"
    }
  ],
  "allow_offline_access": true,
  "skip_consent_for_verifiable_first_party_clients": true,
  "token_lifetime": 86400,
  "token_lifetime_for_web": 86400,
  "enforce_policies": true
}
修改于 2022-03-15 10:55:52
上一页
创建资源服务器
下一页
更新资源服务器
Built with