检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
企业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参数 参数 是否必选
认证登录获取授权码 功能介绍 用户访问集成应用时,应用向OneAccess发起授权登录请求(重定向方式),用户输入用户密码认证成功后,OneAccess将重定向回应用,并携带授权码code参数。 URI GET /api/v1/oauth2/authorize 表1 Query参数
删除应用账号 功能介绍 删除应用账号。 接口约束 无 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”。
认证登录获取授权码 功能介绍 用户访问集成应用时,应用向OneAccess发起授权登录请求(重定向方式),用户输入用户密码认证成功后,OneAccess将重定向回应用回调地址,并携带授权码code参数。 接口约束 无 URI GET /api/v1/oauth2/authorize
禁用应用账号 功能介绍 禁用应用账号。 接口约束 无 URI PUT /api/v2/tenant/applications/{application_id}/accounts/{account_id}/disable 表1 路径参数 参数 是否必选 参数类型 描述 application_id
删除组织 功能介绍 删除指定组织。 接口约束 无 URI DELETE /api/v2/tenant/organizations/{org_id} 表1 路径参数 参数 是否必选 参数类型 描述 org_id 是 String 要删除的组织id(如果存在子组织无法删除)。 请求参数
参数类型 描述 access_token String 授权服务器返回给第三方应用的访问令牌。 token_type String 访问令牌类型。固定值:Bearer。 expires_in Long 访问令牌的有效期,以秒为单位。 scope String 授权范围。 refresh_token
条件访问控制、自定义API访问控制、身份同步、云桥Agent等,详情请参考产品规格差异。 选择适合版本和规格 用户可以根据自己的业务场景选择合适的OneAccess规格,在此做如下推荐: 如果用户数量较少,功能需求简单,不会使用到应用身份管理服务的高级特性,例如条件访问控制、身份同步、云桥等,建议使用基础版实例。
删除用户 功能介绍 删除用户。 接口约束 无 URI DELETE /api/v2/tenant/users/{user_id} 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户id。 请求参数 表2 请求Header参数 参数 是否必选 参数类型
查询应用机构详情 功能介绍 查询应用机构详情。 接口约束 无 URI GET /api/v2/tenant/applications/{application_id}/organizations/{org_id} 表1 路径参数 参数 是否必选 参数类型 描述 application_id
参数类型 描述 access_token String 授权服务器返回给第三方应用的访问令牌。 token_type String 访问令牌类型。固定值:Bearer。 expires_in String 访问令牌的有效期,以秒为单位。 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
参数类型 描述 access_token String 授权服务器返回给第三方应用的访问令牌。 token_type String 访问令牌类型。固定值:Bearer。 expires_in String 访问令牌的有效期,以秒为单位。 scope String 授权范围。 refresh_token
查询组织详情 功能介绍 通过组织id查询组织详情。 接口约束 无 URI GET /api/v2/tenant/organizations/{org_id} 表1 路径参数 参数 是否必选 参数类型 描述 org_id 是 String 组织id。 请求参数 表2 请求Header参数
新增应用机构 功能介绍 新增应用机构。 接口约束 无 URI POST /api/v2/tenant/applications/{application_id}/organizations 表1 路径参数 参数 是否必选 参数类型 描述 application_id 是 String
ss用户门户访问和操作应用。 获取用户访问域名 在调用接口时,请求头中需要填入用户访问域名{domain_name},需要获取此域名。 该域名需由创建人在应用身份管理服务控制台获取。步骤如下: 管理员登录应用身份管理服务控制台。 单击用户访问域名后的复制,获取用户访问域名。 图1
退出登录 功能介绍 退出登录。 URI GET /api/v2/sdk/logout 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-operating-sys-version 是 String 调用方操作系统版本,例如:Android 10。 X-device-fingerprint