32 KiB
32 KiB
AppApi
[toc]
create(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| name | string | false | 应用名称 |
| type | string | false | 应用类型1，自建应用，2模板应用（市场应用） |
| template_id | string | false | 模板id，不填写则代表自建应用 |
| category | string | false | 应用分类,1 标准web应用，2单页web应用，3客户端应用，4后端服务 |
| descr | string | false | 应用描述 |
| logo | string | false | logo路径，格式为：http://ip:port/logo.png |
| login_url | string | false | 登录路径 |
| redirect_url | string | false | 重定向路径 |
| logout_url | string | false | 登出路径 |
| sub_account_policy | string | false | 子账号策略，1启用，0不启用，启用后单点登录返回 |
| prop | object | false | kv字典数据 |
| protocol_type | string | false | 如果不传默认是oidc |
| protocol_prop | object | false | 单点登录协议属性，如果不存在则为oidc的配置 |
| config_prop | object | false | 应用配置属性 |
| domain_sn | string | false | 域名 |
modify(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | string | true | |
| name | string | false | 应用名称 |
| type | string | false | 应用类型，1自建应用，2市场应用 |
| app_id | string | false | 应用key |
| app_secret | string | false | 应用secret，拥有管理员权限时返回 |
| category | string | false | 应用分类 |
| descr | string | false | 应用描述 |
| logo | null | false | logo路径 |
| login_url | string | false | 登录路径 |
| redirect_url | string | false | 重定向路径 |
| logout_url | string | false | 登出路径 |
| sub_account_policy | string | false | 子账号策略 |
| prop | object | false | 扩展属性 |
| status | string | false | 状态，0禁用，1启用 |
| domain_sn | string | false | 应用 Domain SN |
getTemplate(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| name | string | true | 应用名称 |
list(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| name | string | false | 应用名称 |
| type | string | false | 应用类型 |
| page_sort | string | false | 排序，格式：字段名[顺序] |
| types | string | false | 应用类型列表，逗号分隔 |
getByDomain(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| domain | string | false | 域名 |
| domain_sn | string | false | 域名简写 |
get(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | string | true | 唯一标识 |
enable(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | string | true | 应用标识 |
disable(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | string | true | 应用标识 |
delete(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | string | true |
createSecrets(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | string | true |
getConfig(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | string | true | 应用ID |
modifyConfig(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | string | true | |
| allowed_login_method | string | false | 允许的登录方式，格式为：["password", "vercode"] |
| default_login_method | string | false | 默认登录方式，格式为：password |
| allowed_reg_method | string | false | 允许注册方式，格式为：["mobile", "email"] |
| default_reg_method | string | false | 默认注册方式，格式为：mobile |
| default_protocol | string | false | 默认登录协议 |
| access_policy | string | false | 应用级访问控制权限，all: 所有人可访问 permitted: 拒绝未授权访问 |
| reg_policy | string | false | 新用户注册策略（是否允许自动注册，注册验证方式等），1是，2否, |
disableSSO(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | string | true | 应用标识 |
enableSSO(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | string | true | 应用标识 |
createMFA(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | true | 应用id | |
| config_id | string | true | 已配置的idp conn id |
deleteMFA(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| app_id | string | true | 应用id |
| config_id | true |
createIDP(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | true | 应用id | |
| config_id | string | true | 已配置的idp conn id |
deleteIDPConfig(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| app_id | string | true | 应用id |
| config_id | true |
enableProtocol(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| app_id | true | 应用 id | |
| protocol_type | true | 协议名称，如 oidc |
disableProtocol(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| app_id | true | 应用 id | |
| protocol_type | true | 协议名称，如 oidc |
getProtocols(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | string | true | 应用唯一标识ID |
| status | string | false | 启用状态 1, 0 |
getProtocol(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| app_id | true | 应用id | |
| protocol_type | true | 单点类型，cas、oauth2、saml、oidc、sxp |
modifyProtocol(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| app_id | true | 应用id | |
| protocol_type | true | 单点类型，cas、oauth2、saml、oidc、sxp | |
| config_content | object | false | 配置参数 |
createAccount(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| id | true | 应用id | |
| user_id | string | false | 用户唯一标识 |
| app_id | string | false | 应用唯一标识 |
| acc_name | string | false | 帐号名 |
| acc_name_displayed | string | false | 显示名 |
| acc_source | string | false | 帐号来源 |
| acc_password | string | false | 帐号密码 |
| acc_status | string | false | 帐号状态，1启用，0禁用 |
| acc_prop | object | false | 扩展属性 |
| usernmae | string | false | 用户名称 |
modifyAccount(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| app_id | string | true | 应用id |
| id | true | 子账号id | |
| user_id | string | false | 用户唯一标识 |
| app_id | string | false | 应用唯一标识 |
| acc_name | string | false | 帐号名 |
| acc_name_displayed | string | false | 显示名 |
| acc_source | string | false | 帐号来源 |
| acc_password | string | false | 密码 |
| acc_status | string | false | 状态，1启用，0禁用 |
| acc_prop | object | false | 扩展属性 |
enableAccount(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| app_id | true | 应用id | |
| id | string | true | 子账号id |
| id | string | true |
disableAccount(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| app_id | true | 应用id | |
| id | string | true | 子账号id |
deleteAccount(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| app_id | true | 应用id | |
| id | string | true | 子账号id |
getAccounts(param)
param properties
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| app_id | string | false | 应用id |
| user_id | string | false | 用户id |
| acc_status | string | false | 账号状态 1-活跃 0-冻结 |
| page_num | integer | false | 页数 |
| page_size | integer | false | 页大小 |
| page_sort | string | false | 排序字段 |