检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
企业API使用 场景简介 OneAccess提供第三方API的授权管理功能,API提供者将API配置到OneAccess之后,API消费者在使用API之前需要先到OneAccess获取鉴权Token,在使用API时携带该鉴权Token,API提供者根据鉴权Token判断是否可以提供服务,用以实现API的授权管理功能。
查询用户列表 功能介绍 查询用户列表。 接口约束 无 URI GET /api/v2/tenant/users 表1 Query参数 参数 是否必选 参数类型 描述 org_id 是 String 组织id,为空时查询所有用户。 offset 是 Integer 第几页。 最小值:0
新增应用侧角色成员 功能介绍 新增应用侧角色成员。 URI POST /api/v2/tenant/applications/{application_id}/role-member 表1 路径参数 参数 是否必选 参数类型 描述 application_id 是 String 应用id。
新增应用机构 功能介绍 新增应用机构。 接口约束 无 URI POST /api/v2/tenant/applications/{application_id}/organizations 表1 路径参数 参数 是否必选 参数类型 描述 application_id 是 String
获取国际区号 功能介绍 获取支持的国际区号。 URI GET /api/v2/sdk/country-codes 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android
新增用户事件 通过该接口将新增的用户同步至应用系统。 URL POST https://{app_domain}/callback 请求头 Authorization: Bearer {access_token} 请求参数 以下请求参数以企业实际配置的身份同步参数为准,企业管理员可以参考9设置同步至目标应用的属性。
获取图形验证码 功能介绍 获取图形验证码。 URI GET /api/v2/sdk/captcha 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android 10。
根据用户名查询用户详情 功能介绍 根据用户名查询用户详情。 接口约束 无 URI POST /api/v2/tenant/users/user-by-username 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String
隐式授权 功能介绍 用户访问集成应用时,应用通过隐式授权方式获取Access Token和ID Token,向OneAccess发起授权登录请求(重定向方式),用户输入用户密码认证成功后,OneAccess将重定向回应用,并携带Access Token和ID Token参数。 URI
根据用户id查询用户详情 功能介绍 根据用户id查询用户详情。 URI GET /api/v2/tenant/users/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。 请求参数 表2 请求Header参数 参数 是否必选
修改用户 功能介绍 修改用户。 接口约束 无 URI PUT /api/v2/tenant/users/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。 请求参数 表2 请求Header参数 参数 是否必选 参数类型
通过state_Token获取手机号 功能介绍 用于手机号短信二次认证时,通过state_token获取手机号。 URI GET /api/v2/sdk/mobile-by-token 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version
刷新session_token 功能介绍 刷新session_token。 URI POST /api/v2/tenant/sso/session-token/refresh 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String
查询应用账号列表 功能介绍 查询一个应用被授权访问的账号列表。 接口约束 无 URI GET /api/v2/tenant/applications/{application_id}/accounts 表1 路径参数 参数 是否必选 参数类型 描述 application_id 是
修改组织事件 通过该接口将更新的组织同步至应用系统。 URL POST https://{app_domain}/callback 请求头 Authorization: Bearer {access_token} 请求参数 表1 请求参数 参数 固定参数 参数类型 描述 id 是
新增组织事件 通过该接口将新增的组织同步至应用系统。 URL POST https://{app_domain}/callback 请求头 Authorization: Bearer {access_token} 请求参数 以下请求参数以企业实际配置的机构属性为准,企业管理员可以参考8设置同步至目标应用的属性。
删除组织事件 通过该接口将删除的组织同步至应用系统。 URL POST https://{app_domain}/callback 请求头 Authorization: Bearer {access_token} 请求参数 表1 请求参数 参数 参数类型 描述 id String
创建用户 功能介绍 创建用户。 接口约束 无 URI POST /api/v2/tenant/users 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。
校验原密码修改用户密码 功能介绍 校验原密码修改用户密码。 接口约束 无 URI PUT /api/v2/tenant/users/{user_id}/change-password-verify 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。
修改用户密码 功能介绍 修改用户密码。 接口约束 无 URI PUT /api/v2/tenant/users/{user_id}/change-password 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。 请求参数 表2 请求Header参数