检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 概述 新增组织事件 修改组织事件 删除组织事件 新增用户事件 修改用户事件 删除用户事件 父主题: 通过事件回调方式同步数据至应用
管理管理员权限 OneAccess支持对管理门户的权限进行管理,您可以根据需要添加管理员、管理组,并配置相应的使用权限。 管理员分为超级管理员、分级管理员、系统管理员: 超级管理员:拥有管理门户所有组织架构、应用、菜单的管理权限。 分级管理员:拥有管理门户所授权的组织架构、应用、菜单(首页菜单除外)的管理权限。
资源管理概述 OneAccess支持对资源进行统一管理,包括对应用、企业API的管理。本章旨在为您介绍在OneAccess中如何管理企业应用、企业API。 应用 应用可以理解为企业的下游系统,OneAccess支持基于SAML、OAuth2、OIDC、CAS协议的单点登录,同时,
短信网关配置 短信网关是OneAccess提供给用户的一种通过手机获取信息或验证码的方式,包括内置网关、自定义网关两种方式。 在您购买创建OneAccess时会自动配置短信次数,默认每月发送1000次短信免费,超过此次数就无法发送短信了,当超过后若还需短信服务,请参考下文配置短信网关或联系技术人员添加发送短信次数。
管理对象模型 对象模型是OneAccess的数据同步至下游应用的基础,包括应用账号模型和应用机构模型。 在开启同步配置后,OneAccess已定义了账号名、姓名、应用机构等常规的内置属性,如需同步更多的属性,可通过在对象模型处添加属性并配置映射实现。同步时,需保持添加的属性名与应
公共返回码 事件回调接口采用HTTP状态码表示操作结果成功或者失败。企业应用的回调服务参考以下错误码及错误提示进行返回,OneAccess将返回的错误码和错误信息保存到应用同步记录中。 表1 公共返回码 返回码code 说明 200 success。 400 参数XX已存在,如参数userName已存在。
管理API权限 API权限支持管理员在OneAccess管理门户中,授权需要调用API产品的应用,具体操作请参考授权内置API产品。 授权API后,可以调用API实现相关接口功能,具体操作请参考调用内置API产品。 父主题: 应用管理
准备工作 OneAccess提供身份数据同步的功能,数据同步的关系模型可以理解为“上游—中游—下游”。其中“上游”指各种核心身份源,例如钉钉、企业微信、HR系统、也可以是OneAccess本身的身份管理模块,“中游”即OneAccess,“下游”指各类需要和上游保持同步的应用系统
查询个人信息 功能介绍 用户登录成功后查询个人信息时调用本接口。 URI GET /api/v2/sdk/profile 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android
通过手机号找回密码 功能介绍 用户在登录页面单击忘记密码,并选择通过手机号找回密码时,需要输入手机号、验证码、新的密码并通过图形验证码校验后调用本接口。 URI POST /api/v2/sdk/pwd/update-by-mobile 请求参数 表1 请求Header参数 参数
删除组织事件 通过该接口将删除的组织同步至应用系统。 URL POST https://{app_domain}/callback 请求头 Authorization: Bearer {access_token} 请求参数 表1 请求参数 参数 参数类型 描述 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”。
callback 请求头 Authorization: Bearer {access_token} 请求参数 以下请求参数以企业实际配置的身份同步参数为准,企业管理员可以参考9设置同步至目标应用的属性。 表1 请求参数 参数 固定参数 参数类型 描述 username 是 String(100)
删除用户事件 通过该接口将删除的用户同步至应用系统。 URL POST https://{app_domain}/callback 请求头 Authorization: Bearer {access_token} 请求参数 表1 请求参数 参数 参数类型 描述 id String
启用/禁用/删除应用 禁用/启用应用 如果需要暂时关闭该应用,可在应用信息页面禁用该应用。 登录OneAccess管理门户。 在导航栏中,选择“资源 > 应用”。 在应用页面,单击某应用进入应用信息页面。 单击页面右上角的,在弹框中单击“确定”该应用禁用成功。已禁用的应用会进入“已禁用应用”列表。
新增组织事件 通过该接口将新增的组织同步至应用系统。 URL POST https://{app_domain}/callback 请求头 Authorization: Bearer {access_token} 请求参数 以下请求参数以企业实际配置的机构属性为准,企业管理员可以参考8设置同步至目标应用的属性。
修改个人信息 功能介绍 用户登录成功后修改个人信息时调用本接口,本接口不支持修改个人密码、手机号、邮箱。 URI POST /api/v2/sdk/profile/update 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String
接口调用说明 接口格式 OneAccess同步事件回调接口的请求方式为POST,数据编码为UTF-8,数据格式为JSON。 如果应用系统接收事件回调的URL为 https://{app_domain}/callback,当OneAccess的企业发生组织机构或用户变动时,OneA
修改用户事件 通过该接口将更新的用户同步至应用系统。 URL POST https://{app_domain}/callback 请求头 Authorization: Bearer {access_token} 请求参数 表1 请求参数 参数 固定参数 参数类型 描述 id 是