检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
获取访问凭据 功能介绍 获取应用的API访问凭据。Token的有效期默认为30分钟,可在管理门户-设置-服务配置-API认证配置中设置过期时间修改。建议进行缓存,避免频繁调用。使用Token前请确保Token离过期有足够的时间,防止调用API的过程中Token过期导致调用API失败
修改组织事件 通过该接口将更新的组织同步至应用系统。 URL POST https://{app_domain}/callback 请求头 Authorization: Bearer {access_token} 请求参数 表1 请求参数 参数 固定参数 参数类型 描述 id 是
刷新Access Token 功能介绍 刷新AccessToken。 URI POST /api/v1/oauth2/token 请求参数 表1 FormData参数 参数 是否必选 参数类型 描述 client_id 是 String 应用标识,注册应用后,分配的ClientId
应用账号管理 新增应用账号 更新应用账号 删除应用账号 查询应用账号详情 查询应用账号列表 启用应用账号 禁用应用账号 父主题: 管理类接口
删除用户 功能介绍 删除用户。 接口约束 无 URI DELETE /api/v2/tenant/users/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。 请求参数 表2 请求Header参数 参数 是否必选 参数类型
启用用户 功能介绍 启用用户。 接口约束 无 URI PUT /api/v2/tenant/users/{user_id}/enable 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。 请求参数 表2 请求Header参数 参数 是否必选
基于CAS的应用认证集成 认证登录 验证票据(CAS3.0) 注销登录 验证票据(CAS1.0) 验证票据(CAS2.0) 父主题: 应用集成接口
应用侧角色管理 新增应用侧角色 修改应用侧角色信息 删除应用侧角色 查询应用侧角色详情 查询应用侧角色列表 新增应用侧角色成员 删除应用侧角色成员 查询应用侧角色成员列表 父主题: 管理类接口
跳过强制修改密码 功能介绍 调用密码登录相关接口时,如果密码快过期,并且用户选择跳过修改密码时调用本接口,需要传入对应的state_token。 URI GET /api/v2/sdk/pwd/skip-update 请求参数 表1 请求Header参数 参数 是否必选 参数类型
社交账号解绑 功能介绍 社交账号解绑。 URI POST /api/v2/sdk/social/unbind-account 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json
认证登录获取授权码 功能介绍 用户访问集成应用时,应用向OneAccess发起授权登录请求(重定向方式),用户输入用户密码认证成功后,OneAccess将重定向回应用,并携带授权码code参数。 URI GET /api/v1/oauth2/authorize 表1 Query参数
获取AccessToken 功能介绍 获取Access Token,Access Token可用于调用获取用户信息API。 接口约束 无 URI POST /api/v1/oauth2/token 请求参数 表1 FormData参数 参数 是否必选 参数类型 描述 code 是
新增组织事件 通过该接口将新增的组织同步至应用系统。 URL POST https://{app_domain}/callback 请求头 Authorization: Bearer {access_token} 请求参数 以下请求参数以企业实际配置的机构属性为准,企业管理员可以参考
全局退出 功能介绍 注销会话退出登录,当用户退出第三方应用系统时,除退出应用系统本身的会话外,同时将销毁OneAccess生成的SSO票据,OneAccess销毁SSO票据后,浏览器将重定向到应用端指定的回调地址URL。 接口约束 无 URI GET /api/v1/logout
修改用户密码 功能介绍 修改用户密码。 接口约束 无 URI PUT /api/v2/tenant/users/{user_id}/change-password 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。 请求参数 表2 请求Header
用户授权应用账号 功能介绍 为用户授予应用访问权限,并在应用中创建用户对应的应用账号。 接口约束 无 URI POST /api/v2/tenant/users/{user_id}/applications/{application_id}/accounts 表1 路径参数 参数
查询组织列表 功能介绍 查询指定组织及其下的子组织列表。 接口约束 无 URI GET /api/v2/tenant/organizations 表1 Query参数 参数 是否必选 参数类型 描述 all_child 否 Boolean 是否获取所有层级子组织。 缺省值:false
查询用户列表 功能介绍 查询用户列表。 接口约束 无 URI GET /api/v2/tenant/users 表1 Query参数 参数 是否必选 参数类型 描述 org_id 是 String 组织id,为空时查询所有用户。 offset 是 Integer 第几页。 最小值:
认证登录获取授权码 功能介绍 用户访问集成应用时,应用向OneAccess发起授权登录请求(重定向方式),用户输入用户密码认证成功后,OneAccess将重定向回应用回调地址,并携带授权码code参数。 接口约束 无 URI GET /api/v1/oauth2/authorize
用户名密码登录 功能介绍 用户名密码登录,正常调用成功会返回用户的session_token,开启密码过期检查或二次认证会返回state_token,失败返回失败信息。 URI POST /api/v2/sdk/login 请求参数 表1 请求Header参数 参数 是否必选 参数类型