- 快速开始
- 身份源(Connection)
- 应用(Client)
- 资源服务器(ResourceServer)
- 用户(User)
- 角色(Role)
- 分组(Group)
- 租户(Tenant)
- 组织(Organization)
- 动作(Action)
- 授权(Grant)
- 应用授权(ClientGrant)
- 日志(Log)
- 自定义域名(CusomDomain)
- 密钥(Key)
- 任务(Job)
- 多因素认证(MFA)
- 安全防护(AttackProtection)
- 品牌化(Branding)
获取应用列表
GET
/api/v1/clients
应用
请求参数
Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token示例:
Authorization: Bearer ********************
Query 参数
page
integer
页码
示例值:
1
page_size
integer
可选
示例值:
10
sort
string
可选
示例值:
-created_at
fields
string
可选
示例值:
client_id,name
示例代码
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'
返回响应
🟢200成功
application/json
Body
meta
object (PageMeta)
必需
page
integer
页码
page_size
integer
每页显示数量
total
integer
记录总数
items
array[object (Client) {37}]
必需
display_name
string
可读名称
response_types
array[string]
响应类型
枚举值:
codeid_token tokentoken
tenant
string
租户ID
name
string
应用名
description
string
描述
logo_uri
string
logo链接
redirect_uris
array[string]
重定向链接
allowed_origins
array[string]
允许的访问来源
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
必需
encryption_key
object
必需
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
必需
client_metadata
object
必需
mobile
object
必需
initiate_login_uri
string
初始登录链接
native_social_login
object
必需
refresh_token
object
必需
organization_usage
string
必需
organization_require_behavior
string
必需
client_id
string
应用ID
client_secret
string
应用密钥
示例
{
"meta": {
"page": 1,
"page_size": 20,
"total": 1
},
"items": [
{
"display_name": "商城后端",
"response_types": [
"token",
"id_token token",
"code"
],
"tenant": "tenant",
"name": "ec-web",
"redirect_uris": [
"https://mydomain/callback"
],
"allowed_origins": [
"https://mydomain"
],
"allowed_logout_urls": [
"https://mydomain/logout"
],
"token_endpoint_auth_method": "none",
"grant_types": [
"authorization_code",
"client_credentials"
],
"app_type": "native",
"is_first_party": true,
"oidc_conformant": true,
"jwt_configuration": {
"lifetime_in_seconds": 86400,
"alg": "RS256"
},
"encryption_key": {
"pub": "ea Ut qui",
"cert": "aute tempor eu id",
"subject": "ullamco dolor officia elit adipisicing"
},
"sso": true,
"cross_origin_auth": true,
"sso_disabled": true,
"addons": {
"sso_integration": "nulla minim veniam dolor"
},
"initiate_login_uri": "https://mydomain/login",
"client_id": "T3N340S-OGz5mNc5-BqxVhP9JD_NbeGQ",
"client_secret": "23N340S-OGz5mNc5-BqxVhP9JD_NbeGQT3N340S-OGz5mNc5-BqxVhP9JD_NbeGQ"
}
]
}
修改于 2022-03-15 10:17:23