检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API 基于OAuth的应用认证集成 基于CAS的应用认证集成
API概览 OrgID服务提供了多个API接口,包含获取Access Token、获取用户信息等的接口,如表1所示。 表1 接口说明 API 说明 获取AccessToken 获取Access Token,Access Token可用于调用获取用户信息API。 获取用户信息 获取用户信息。
如何调用API 构造请求 返回结果
验证票据 功能介绍 CAS3.0方式应用验证票据,并获取用户属性信息。 URI GET /orgid/openapi/v1/cas/p3/serviceValidate 表1 Query参数 参数 是否必选 参数类型 描述 service 是 String 登录时携带的回调地址。
构造请求 本节介绍REST API请求的组成,并以调用获取Access Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987
参见状态码。 对于获取Access Token接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头 该部分可选。 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于Access Token接口,不返回响应消息头。 响应消息体 该部分可选。响
基于OAuth的应用认证集成 获取AccessToken 获取用户信息 父主题: API
基于CAS的应用认证集成 验证票据 父主题: API
Token,Access Token可用于调用获取用户信息API。 URI POST /orgid/openapi/v1/oauth2/token 请求参数 表1 FormData参数 参数 是否必选 参数类型 描述 grant_type 是 String 授权方式,该参数为固定值authorization_code。
error String 错误码(兼容原开放接口字段)。 error_description String 错误描述(兼容原开放接口字段)。 请求示例 GET https://orgid.huaweiapaas.cn/orgid/openapi/v1/oauth2/userinfo --header
附录 状态码 错误码
修订记录 发布日期 修订记录 2024-02-29 第一次正式发布。
使用前必读 概述 调用说明 终端节点
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 无 Bad Request url clientId clientSecret错误。 检查调用参数或者联系运营开发人员定位。 401 OrgID
服务。OrgID通过将Huawei ID扩展到组织内部应用领域,实现对组织部门、用户、账号、应用、认证源的统一管理。 在调用OrgID的API之前,请确保已经充分了解OrgID相关概念,详细信息请参见OrgID。 父主题: 使用前必读
调用说明 OrgID提供了REST(Representational State Transfer)风格API,支持通过HTTPS请求调用。 调用方法请参见如何调用API。 父主题: 使用前必读
状态码 状态码如表1所示。 表1 状态码 状态码 编码 说明 200 OK 正常响应。 400 Bad Request 参数错误响应。 401 Unauthorized 权限错误响应。 500 Internal Server Error 系统错误响应。 父主题: 附录
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同。 使用OrgID服务API无需关注终端节点,需要使用OrgID的公网访问域名,OrgID的公网访问域名为“orgid.huaweiapaas.cn”。 父主题: 使用前必读
OrgID产品架构请参考图1。 图1 OrgID产品架构 访问方式 应用注册协议 SaaS应用接入OrgID云服务,需要遵从联运KIT规范接入改造,主要是对接统一账号,详细请见联营SaaS接入流程介绍。 控制台方式 如果用户已注册公有云,可直接登录管理控制台,从主页选择“组织成员账号 Or
每次申请增加100个成员配额,最大成员数不超过5000。 部门最大层级不超过5级,一个组织最多可以有999个部门。 OrgID当前只支持公有云,不支持HCS,伙伴云。 负责业务应用系统的统一认证,但应用的会话(与客户端的会话Session保持)不在OrgID管理范围。