Authok管理API
  1. 应用(Client)
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. 应用(Client)

查找应用

GET
/api/v1/clients/{client_id}
应用

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Path 参数
client_id
string 
应用ID
必需
示例值:
B332ijfeefe9jwfjewjofwejo

示例代码

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/clients/B332ijfeefe9jwfjewjofwejo'

返回响应

🟢200成功
application/json
Body
display_name
string 
可读名称
必需
应用的可读名称
response_types
array[string]
响应类型
必需
响应类型
枚举值:
codeid_token tokentoken
tenant
string 
租户ID
必需
应用所属的租户ID
name
string 
应用名
必需
应用名
description
string 
描述
必需
描述
logo_uri
string 
logo链接
必需
应用logo链接地址
redirect_uris
array[string]
重定向链接
必需
重定向链接
allowed_origins
array[string]
允许的访问来源
必需
允许的访问来源,CORS配置
web_origins
array[string]
必需
client_aliases
array[string]
应用别名
必需
应用别名
allowed_clients
array[string]
必需
allowed_logout_urls
array[string]
允许的退登地址
必需
允许的退登地址
token_endpoint_auth_method
enum<string> 
端点授权方式
必需
端点授权方式
枚举值:
client_secret_basicclient_secret_jwtclient_secret_postprivate_key_jwtnone
grant_types
array[string]
授权类型
必需
授权类型
枚举值:
authorization_codeimplicitrefresh_tokenclient_credentialspasswordhttp://authok.cn/oauth/grant-type/password-realmhttp://authok.cn/oauth/grant-type/mfa-oobhttp://authok.cn/oauth/grant-type/mfa-otphttp://authok.cn/oauth/grant-type/passwordless/otphttp://authok.cn/oauth/grant-type/mfa-recovery-codeurn:ietf:params:oauth:grant-type:device_code
app_type
enum<string> 
应用类型
必需
应用类型
枚举值:
non_interactivenativewebspa
is_first_party
boolean 
是否第一方应用
必需
是否第一方应用
oidc_conformant
boolean 
必需
jwt_configuration
object 
必需
lifetime_in_seconds
integer 
必需
scopes
object 
必需
alg
string 
必需
encryption_key
object 
必需
pub
string 
必需
cert
string 
必需
subject
string 
必需
sso
boolean 
必需
cross_origin_auth
boolean 
必需
cross_origin_loc
string 
必需
sso_disabled
boolean 
必需
custom_login_page_on
boolean 
必需
custom_login_page
string 
必需
custom_login_page_preview
string 
必需
form_template
string 
必需
addons
object 
必需
aws
object 
必需
azure_blob
object 
必需
azure_sb
object 
必需
rms
object 
必需
mscrm
object 
必需
slack
object 
必需
sentry
object 
必需
box
object 
必需
cloudbees
object 
必需
concur
object 
必需
dropbox
object 
必需
echosign
object 
必需
egnyte
object 
必需
firebase
object 
必需
newrelic
object 
必需
office365
object 
必需
salesforce
object 
必需
salesforce_api
object 
必需
salesforce_sandbox_api
object 
必需
samlp
object 
必需
layer
object 
必需
sap_api
object 
必需
sharepoint
object 
必需
springcm
object 
必需
wams
object 
必需
wsfed
object 
必需
zendesk
object 
必需
zoom
object 
必需
sso_integration
string 
必需
client_metadata
object 
必需
mobile
object 
必需
android
object 
必需
ios
object 
必需
initiate_login_uri
string 
初始登录链接
必需
初始登录链接
native_social_login
object 
必需
apple
string 
必需
facebook
string 
必需
refresh_token
object 
必需
rotation_type
string 
必需
expiration_type
string 
必需
leeway
integer 
必需
token_lifetime
integer 
必需
infinite_token_lifetime
boolean 
必需
idle_token_lifetime
integer 
必需
infinite_idle_token_lifetime
boolean 
必需
organization_usage
string 
必需
organization_require_behavior
string 
必需
client_id
string 
应用ID
必需
应用ID
client_secret
string 
应用密钥
必需
应用密钥
示例
{
  "display_name": "电商前端应用",
  "response_types": [
    "code",
    "id_token token",
    "token"
  ],
  "tenant": "ji32feofwjioeo",
  "name": "order-app",
  "logo_uri": "https://mydomain/logo.svg",
  "redirect_uris": [
    "https://mydomain/callback"
  ],
  "allowed_origins": [
    "https://mydomain"
  ],
  "allowed_logout_urls": [
    "https://mydomain/logout"
  ],
  "token_endpoint_auth_method": "client_secret_post",
  "grant_types": [
    "http://authok.cn/oauth/grant-type/password-realm",
    "client_credentials",
    "http://authok.cn/oauth/grant-type/mfa-recovery-code"
  ],
  "app_type": "web",
  "is_first_party": false,
  "oidc_conformant": false,
  "jwt_configuration": {
    "lifetime_in_seconds": 879494546831,
    "scopes": {},
    "alg": "RS256"
  },
  "sso": true,
  "initiate_login_uri": "https://mydomain/login"
}
修改于 2022-03-14 13:00:29
上一页
删除身份源的给定用户
下一页
创建应用
Built with