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