检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
手机短信验证码登录 功能介绍 手机短信验证码登录。 URI POST /api/v2/sdk/login/mobile-verify-code 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“app
根据用户id查询用户详情 功能介绍 根据用户id查询用户详情。 URI GET /api/v2/tenant/users/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。 请求参数 表2 请求Header参数 参数 是否必选
公共返回码 事件回调接口采用HTTP状态码表示操作结果成功或者失败。企业应用的回调服务参考以下错误码及错误提示进行返回,OneAccess将返回的错误码和错误信息保存到应用同步记录中。 表1 公共返回码 返回码code 说明 200 success。 400 参数XX已存在,如参数userName已存在。
管理API权限 API权限支持管理员在OneAccess管理门户中,授权需要调用API产品的应用,具体操作请参考授权内置API产品。 授权API后,可以调用API实现相关接口功能,具体操作请参考调用内置API产品。 父主题: 应用管理
通过sso_ticket获取用户信息 功能介绍 通过sso_ticket获取用户信息。 URI POST /api/v2/tenant/sso/sso-ticket/verify 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String
删除组织事件 通过该接口将删除的组织同步至应用系统。 URL POST https://{app_domain}/callback 请求头 Authorization: Bearer {access_token} 请求参数 表1 请求参数 参数 参数类型 描述 id String
新增应用侧角色成员 功能介绍 新增应用侧角色成员。 URI POST /api/v2/tenant/applications/{application_id}/role-member 表1 路径参数 参数 是否必选 参数类型 描述 application_id 是 String 应用id。
查询应用账号列表 功能介绍 查询一个应用被授权访问的账号列表。 接口约束 无 URI GET /api/v2/tenant/applications/{application_id}/accounts 表1 路径参数 参数 是否必选 参数类型 描述 application_id 是
查询应用侧角色详情 功能介绍 查询应用侧角色详情。 URI GET /api/v2/tenant/applications/{application_id}/role/{role_id} 表1 路径参数 参数 是否必选 参数类型 描述 application_id 是 String
获取图形验证码 功能介绍 获取图形验证码。 URI GET /api/v2/sdk/captcha 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android 10。
校验图形验证码 功能介绍 校验图形验证码。 URI POST /api/v2/sdk/captcha/verify 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。
新增组织事件 通过该接口将新增的组织同步至应用系统。 URL POST https://{app_domain}/callback 请求头 Authorization: Bearer {access_token} 请求参数 以下请求参数以企业实际配置的机构属性为准,企业管理员可以参考8设置同步至目标应用的属性。
隐式授权 功能介绍 用户访问集成应用时,应用通过隐式授权方式获取Access Token和ID Token,向OneAccess发起授权登录请求(重定向方式),用户输入用户密码认证成功后,OneAccess将重定向回应用,并携带Access Token和ID Token参数。 URI
查询用户所有授权的应用账号 功能介绍 查询用户所有授权的应用账号。 接口约束 无 URI GET /api/v2/tenant/users/{user_id}/accounts 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。 请求参数
新增用户事件 通过该接口将新增的用户同步至应用系统。 URL POST https://{app_domain}/callback 请求头 Authorization: Bearer {access_token} 请求参数 以下请求参数以企业实际配置的身份同步参数为准,企业管理员可以参考9设置同步至目标应用的属性。
删除用户事件 通过该接口将删除的用户同步至应用系统。 URL POST https://{app_domain}/callback 请求头 Authorization: Bearer {access_token} 请求参数 表1 请求参数 参数 参数类型 描述 id String
启用/禁用/删除应用 禁用/启用应用 如果需要暂时关闭该应用,可在应用信息页面禁用该应用。 登录OneAccess管理门户。 在导航栏中,选择“资源 > 应用”。 在应用页面,单击某应用进入应用信息页面。 单击页面右上角的,在弹框中单击“确定”该应用禁用成功。已禁用的应用会进入“已禁用应用”列表。
删除应用侧角色成员 功能介绍 删除应用侧角色成员。 URI DELETE /api/v2/tenant/applications/{application_id}/role-member 表1 路径参数 参数 是否必选 参数类型 描述 application_id 是 String
查询应用机构列表 功能介绍 查询一个应用被授权访问的机构列表 接口约束 无 URI GET /api/v2/tenant/applications/{application_id}/organizations 表1 路径参数 参数 是否必选 参数类型 描述 application_id
根据用户名查询用户详情 功能介绍 根据用户名查询用户详情。 接口约束 无 URI POST /api/v2/tenant/users/user-by-username 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String