检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
该服务支持多种规格,按需购买,减少资源浪费。 访问方式 您可以通过以下两种方式访问OneAccess。 管理控制台 您可以通过基于浏览器的可视化界面,即控制台访问OneAccess。 REST API 您可以使用OneAccess提供的REST API接口以编程方式访问OneAccess。
查询应用账号列表 功能介绍 查询一个应用被授权访问的账号列表。 接口约束 无 URI GET /api/v2/tenant/applications/{application_id}/accounts 表1 路径参数 参数 是否必选 参数类型 描述 application_id 是
插件代填协议,单击“保存”。 应用认证集成方式一旦设置不可修改。 图1 设置认证协议 单击左侧列表中的“认证配置”,配置认证参数。OneAccess支持多种配置方式,包括简单登录、三字段登录、带Frame的登录、两页面登录。不同的登录方式需配置的参数略有差异。 配置参数会明文展示所输入的信息,请防止信息泄露。
获取图形验证码 功能介绍 获取图形验证码。 URI GET /api/v2/sdk/captcha 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android 10。
认证登录获取授权码 功能介绍 用户访问集成应用时,应用向OneAccess发起授权登录请求(重定向方式),用户输入用户密码认证成功后,OneAccess将重定向回应用,并携带授权码code参数。 URI GET /api/v1/oauth2/authorize 表1 Query参数
认证登录获取授权码 功能介绍 用户访问集成应用时,应用向OneAccess发起授权登录请求(重定向方式),用户输入用户密码认证成功后,OneAccess将重定向回应用回调地址,并携带授权码code参数。 接口约束 无 URI GET /api/v1/oauth2/authorize
表2 请求Body参数 参数 是否必选 参数类型 描述 sso_ticket 是 String 一次性访问票据,通过用户登录后的session_token获取一次性访问票据sso_ticket,通过sso_ticket可以获取用户信息。 operating_sys_version
删除组织 功能介绍 删除指定组织。 接口约束 无 URI DELETE /api/v2/tenant/organizations/{org_id} 表1 路径参数 参数 是否必选 参数类型 描述 org_id 是 String 要删除的组织id(如果存在子组织无法删除)。 请求参数
企业API使用 场景简介 OneAccess提供第三方API的授权管理功能,API提供者将API配置到OneAccess之后,API消费者在使用API之前需要先到OneAccess获取鉴权Token,在使用API时携带该鉴权Token,API提供者根据鉴权Token判断是否可以提供服务,用以实现API的授权管理功能。
禁用用户 功能介绍 禁用用户。 接口约束 无 URI PUT /api/v2/tenant/users/{user_id}/disable 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。 请求参数 表2 请求Header参数 参数 是否必选
通过事件回调方式同步数据至应用 准备工作 调用说明 API 公共返回码
删除用户 功能介绍 删除用户。 接口约束 无 URI DELETE /api/v2/tenant/users/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。 请求参数 表2 请求Header参数 参数 是否必选 参数类型
删除应用账号 功能介绍 删除应用账号。 接口约束 无 URI DELETE /api/v2/tenant/applications/{application_id}/accounts/{account_id} 表1 路径参数 参数 是否必选 参数类型 描述 application_id
创建组织 功能介绍 创建组织。 接口约束 无 URI POST /api/v2/tenant/organizations 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 该字段内容填为“application/json;charset=utf8”。
禁用应用账号 功能介绍 禁用应用账号。 接口约束 无 URI PUT /api/v2/tenant/applications/{application_id}/accounts/{account_id}/disable 表1 路径参数 参数 是否必选 参数类型 描述 application_id
参数类型 描述 access_token String 授权服务器返回给第三方应用的访问令牌。 token_type String 访问令牌类型。固定值:Bearer。 expires_in String 访问令牌的有效期,以秒为单位。 scope String 授权范围。 refresh_token
参数类型 描述 access_token String 授权服务器返回给第三方应用的访问令牌。 token_type String 访问令牌类型。固定值:Bearer。 expires_in Long 访问令牌的有效期,以秒为单位。 scope String 授权范围。 refresh_token
启用用户 功能介绍 启用用户。 接口约束 无 URI PUT /api/v2/tenant/users/{user_id}/enable 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。 请求参数 表2 请求Header参数 参数 是否必选
删除应用机构 功能介绍 删除应用机构。 接口约束 无 URI DELETE /api/v2/tenant/applications/{application_id}/organizations/{org_id} 表1 路径参数 参数 是否必选 参数类型 描述 application_id
查询组织详情 功能介绍 通过组织id查询组织详情。 接口约束 无 URI GET /api/v2/tenant/organizations/{org_id} 表1 路径参数 参数 是否必选 参数类型 描述 org_id 是 String 组织id。 请求参数 表2 请求Header参数