检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 OrgID服务提供了多个API接口,包含获取Access Token、获取用户信息等的接口,如表1所示。 表1 接口说明 API 说明 获取AccessToken 获取Access Token,Access Token可用于调用获取用户信息API。 获取用户信息 获取用户信息。
域名添加后,需要在试用期(180天)内完成域名验证。若在试用期内未完成域名验证,域名会被冻结,冻结后将无法使用该域名作为管理式华为账号的后缀。 添加域名 登录管理中心。 选择左侧导航栏的“组织管理 > 域名管理”。 单击页面右上角“添加域名”。 输入组织域名,单击“确定”。 添加完成后该域名会展示在域名列表中。 验证域名
如何调用API 构造请求 返回结果
API 基于OAuth的应用认证集成 基于CAS的应用认证集成
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同。 使用OrgID服务API无需关注终端节点,需要使用OrgID的公网访问域名,OrgID的公网访问域名为“orgid.huaweiapaas.cn”。 父主题: 使用前必读
构造请求 本节介绍REST API请求的组成,并以调用获取Access Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987
error String 错误码(兼容原开放接口字段)。 error_description String 错误描述(兼容原开放接口字段)。 请求示例 POST https://orgid.huaweiapaas.cn/orgid/openapi/v1/oauth2/token Content-Type:
error String 错误码(兼容原开放接口字段)。 error_description String 错误描述(兼容原开放接口字段)。 请求示例 GET https://orgid.huaweiapaas.cn/orgid/openapi/v1/oauth2/userinfo --header
返回结果 请求发送以后,会收到响应,包含:状态码、响应消息头和响应消息体。 状态码 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取Access Token接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头
基于OAuth的应用认证集成 获取AccessToken 获取用户信息 父主题: API
基于CAS的应用认证集成 验证票据 父主题: API
orgid.top,如图1所示。 图1 设置组织域名 已有域名,单击“使用自有域名”,输入自有域名,例如example.com,如图2所示。 图2 使用自有域名 域名设置后管理员为组织创建成员时,成员的管理式华为账号默认带有域名后缀,如设置的组织域名为abc.orgid.top,创建的成员账号为xxx@abc
服务。OrgID通过将Huawei ID扩展到组织内部应用领域,实现对组织部门、用户、账号、应用、认证源的统一管理。 在调用OrgID的API之前,请确保已经充分了解OrgID相关概念,详细信息请参见OrgID。 父主题: 使用前必读
验证票据 功能介绍 CAS3.0方式应用验证票据,并获取用户属性信息。 URI GET /orgid/openapi/v1/cas/p3/serviceValidate 表1 Query参数 参数 是否必选 参数类型 描述 service 是 String 登录时携带的回调地址。
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 无 Bad Request url clientId clientSecret错误。 检查调用参数或者联系运营开发人员定位。 401 OrgID
修订记录 发布日期 修订记录 2024-02-29 第一次正式发布。
附录 状态码 错误码
组织管理 组织信息管理 数据报表 域名管理
使用前必读 概述 调用说明 终端节点
OrgID默认认证源是华为账号,其账号分为个人账号和管理式账号。管理式账号由管理员创建,只能归属于本组织,登录时只能使用账号名登录,不能使用手机号或者邮箱地址登录。 华为账号最多可以创建5个组织,可以申请组织配额,每次申请增加一个组织配额。 每个组织支持管理3个域名。 单个组织默认可以有200个成员,可以申请