检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 OrgID服务提供了多个API接口,包含获取Access Token、获取用户信息等的接口,如表1所示。 表1 接口说明 API 说明 获取AccessToken 获取Access Token,Access Token可用于调用获取用户信息API。 获取用户信息 获取用户信息。
如何调用API 构造请求 返回结果
身份认证与访问控制 身份认证 OrgID提供的身份认证可以分为控制台和云服务两个层面。 控制台层面:OrgID与IAM打通,企业租户可以使用华为云用户名与密码登录,实现租户的认证与鉴权,未授权的不能访问。 数据业务面:租户管理员添加成员后,成员可以直接登录OrgID数据业务面,使用Huawei
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 无 Bad Request url clientId clientSecret错误。 检查调用参数或者联系运营开发人员定位。 401 OrgID
而OrgID云服务开通的相关权限受华为云IAM控制, IAM是华为云提供权限管理的基础服务,无需付费即可使用,您只需要为您账号中的资源进行付费。关于IAM的详细介绍,请参见《IAM产品介绍》。 表1列出了OrgID常用操作与系统角色的关系,您可以通过该表了解系统角色的操作权限。 表1
API 基于OAuth的应用认证集成 基于CAS的应用认证集成
基于OAuth的应用认证集成 获取AccessToken 获取用户信息 父主题: API
基于CAS的应用认证集成 验证票据 父主题: API
获取用户信息 功能介绍 获取用户信息。 URI GET /orgid/openapi/v1/oauth2/userinfo 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-OrgID-Authorization 是 String 用户访问凭证,即Bearer
获取AccessToken 功能介绍 获取Access Token,Access Token可用于调用获取用户信息API。 URI POST /orgid/openapi/v1/oauth2/token 请求参数 表1 FormData参数 参数 是否必选 参数类型 描述 grant_type
添加属性参数说明 参数名称 参数说明 属性展示名 在成员扩展属性中显示的名称。 属性名称 设置属性名称,关联OrgID和第三方系统成员模型之间属性的对应关系。 属性类型 可选择文本框、下拉框-单选、下拉框-多选、日期。 是否必填 选择该属性是否属于必填项。 是否敏感数据 仅当属性类型为文本框时,需选择输入后的数据是否需要密文展示。
构造请求 本节介绍REST API请求的组成,并以调用获取Access Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987
SaaS类各项云服务内部的安全以及对租户定制配置进行安全有效的管理,包括但不限于虚拟网络、虚拟主机和访客虚拟机的操作系统,虚拟防火墙、API网关和高级安全服务,各项云服务,租户数据,以及身份账号和密钥管理等方面的安全配置。 《华为云安全白皮书》详细介绍华为云安全性的构建思路与措施
修订记录 发布日期 修订记录 2024-02-29 第一次正式发布。
概述 组织成员账号OrgID是面向企业提供组织管理、企业成员账号管理以及SaaS应用授权管理能力的云服务。OrgID通过将Huawei ID扩展到组织内部应用领域,实现对组织部门、用户、账号、应用、认证源的统一管理。 在调用OrgID的API之前,请确保已经充分了解OrgID相关概念,详细信息请参见OrgID。
使用前必读 概述 调用说明 终端节点
验证票据 功能介绍 CAS3.0方式应用验证票据,并获取用户属性信息。 URI GET /orgid/openapi/v1/cas/p3/serviceValidate 表1 Query参数 参数 是否必选 参数类型 描述 service 是 String 登录时携带的回调地址。
附录 状态码 错误码
状态码 状态码如表1所示。 表1 状态码 状态码 编码 说明 200 OK 正常响应。 400 Bad Request 参数错误响应。 401 Unauthorized 权限错误响应。 500 Internal Server Error 系统错误响应。 父主题: 附录
返回结果 请求发送以后,会收到响应,包含:状态码、响应消息头和响应消息体。 状态码 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取Access Token接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头