检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API概览 OrgID服务提供了多个API接口,包含获取Access Token、获取用户信息等的接口,如表1所示。 表1 接口说明 API 说明 获取AccessToken 获取Access Token,Access Token可用于调用获取用户信息API。 获取用户信息 获取用户信息
如何调用API 构造请求 返回结果
API 基于OAuth的应用认证集成 基于CAS的应用认证集成
获取组织凭证 组织创建者或组织管理员可以获取组织凭证,用于调用OrgID服务已订阅的开放API接口。 获取组织凭证 登录管理中心。 选择左侧导航栏的“系统管理 > 凭证管理”,进入“凭证管理”页面。 单击Client ID后的“查看”,可以获取Client ID。
调用说明 OrgID提供了REST(Representational State Transfer)风格API,支持通过HTTPS请求调用。 调用方法请参见如何调用API。 父主题: 使用前必读
获取AccessToken 功能介绍 获取Access Token,Access Token可用于调用获取用户信息API。 URI POST /orgid/openapi/v1/oauth2/token 请求参数 表1 FormData参数 参数 是否必选 参数类型 描述 grant_type
返回结果 请求发送以后,会收到响应,包含:状态码、响应消息头和响应消息体。 状态码 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取Access Token接口,如果调用后返回状态码为“200”,则表示请求成功。 响应消息头
构造请求 本节介绍REST API请求的组成,并以调用获取Access Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos
状态码 状态码如表1所示。 表1 状态码 状态码 编码 说明 200 OK 正常响应。 400 Bad Request 参数错误响应。 401 Unauthorized 权限错误响应。 500 Internal Server Error 系统错误响应。 父主题: 附录
获取用户信息 功能介绍 获取用户信息。 URI GET /orgid/openapi/v1/oauth2/userinfo 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-OrgID-Authorization 是 String 用户访问凭证,即Bearer
基于OAuth的应用认证集成 获取AccessToken 获取用户信息 父主题: API
基于CAS的应用认证集成 验证票据 父主题: API
验证票据 功能介绍 CAS3.0方式应用验证票据,并获取用户属性信息。 URI GET /orgid/openapi/v1/cas/p3/serviceValidate 表1 Query参数 参数 是否必选 参数类型 描述 service 是 String 登录时携带的回调地址。
概述 组织成员账号OrgID是面向企业提供组织管理、企业成员账号管理以及SaaS应用授权管理能力的云服务。OrgID通过将Huawei ID扩展到组织内部应用领域,实现对组织部门、用户、账号、应用、认证源的统一管理。 在调用OrgID的API之前,请确保已经充分了解OrgID相关概念
终端节点 终端节点即调用API的请求地址,不同服务不同区域的终端节点不同。 使用OrgID服务API无需关注终端节点,需要使用OrgID的公网访问域名,OrgID的公网访问域名为“orgid.huaweiapaas.cn”。 父主题: 使用前必读
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 无 Bad Request url clientId clientSecret错误。 检查调用参数或者联系运营开发人员定位。 401 OrgID.OAUTH
同步集成配置 通过同步集成配置,可以将该应用的数据同步给配置的第三方系统。详细的同步数据请参见联营Kit接口描述。 配置同步集成信息 登录管理中心。 选择左侧导航栏的“应用管理”。 在“全部应用”页签,单击待修改的应用操作列的“配置”。 单击“同步集成”,进入“同步集成”页签。 配置相关参数
附录 状态码 错误码
使用前必读 概述 调用说明 终端节点
修订记录 发布日期 修订记录 2024-02-29 第一次正式发布。