1. 接口描述
接口请求域名: organization.tencentcloudapi.com 。
开通身份中心服务(CIC)
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:OpenIdentityCenter。 |
Version | 是 | String | 公共参数,本接口取值:2021-03-31。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ZoneName | 是 | String | 空间名,必须全局唯一。包含小写字母、数字和短划线(-)。不能以短划线(-)开头或结尾,且不能有两个连续的短划线(-)。长度:2~64 个字符。 示例值:testName |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
ZoneId | String | 空间ID。z-前缀开头,后面是12位随机数字/小写字母 示例值:z-00fdsg**** |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 开通身份中心服务(CIC)
开通身份中心服务(CIC)
输入示例
POST / HTTP/1.1
Host: organization.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OpenIdentityCenter
<公共请求参数>
{
"ZoneName": "testName"
}
输出示例
{
"Response": {
"ZoneId": "z-dj3jk*****",
"RequestId": "e297543a-80de-4039-83c8-9d324f45"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.DBOperationError | SQL执行报错 |
FailedOperation.IdentityCenterAlreadyOpen | CIC服务已经被开通 |
FailedOperation.IdentityCenterNotAuth | 用户没有实名认证,无法开通CIC服务 |
FailedOperation.IdentityCenterNotEnterpriseAuth | 用户没有企业实名认证,无法开通CIC服务 |
FailedOperation.IdentityCenterNotOrganizationManager | 用户不是集团账号管理员,无法开通CIC服务 |
FailedOperation.IdentityCenterOrganizationNotOpen | 用户没有开通集团账号,无法开通CIC服务 |
InvalidParameterValue.IdentityCenterZoneNameAlreadyExist | CIC空间名称已经存在,需要更换空间名称。 |
ResourceNotFound.ServiceRoleNotExist | 组织服务角色不存在。 |