1. 接口描述
接口请求域名: cam.tencentcloudapi.com 。
创建角色OIDC配置
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateOIDCConfig。 |
Version | 是 | String | 公共参数,本接口取值:2019-01-16。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
IdentityUrl | 是 | String | 身份提供商URL 示例值:https://xxx.qq.cn/oidc |
ClientId.N | 是 | Array of String | 客户端ID 示例值:61adcf00620c31e3ddbc9546 |
Name | 是 | String | 名称 示例值:OIDC |
IdentityKey | 是 | String | 签名公钥,需要base64 |
Description | 否 | String | 描述 示例值:描述 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 添加角色OIDC配置
输入示例
POST / HTTP/1.1
Host: cam.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateOIDCConfig
<公共请求参数>
{
"IdentityKey": "ewogICAgImtleXMiOiBbCiAgIC***************V9jenYyT0kiCiAgICAgICAgfQogICAgXQp9",
"IdentityUrl": "https://*******.qq.cn/",
"Name": "oidc",
"ClientId": [
"61adcf00******ddbc9546"
],
"Description": "Desc"
}
输出示例
{
"Response": {
"RequestId": "0d8de866-7385-4230-8f28-060a92d723ee"
}
}
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 | 操作失败。 |
InvalidParameter | 参数错误。 |
InvalidParameter.IdentityNameInUse | 身份提供商名称已经使用。 |
InvalidParameterValue.IdentityUrlError | 身份提供商URL错误。 |
InvalidParameterValue.MetadataError | 身份提供商元数据文档错误。 |
InvalidParameterValue.NameError | 身份提供商名称错误。 |
LimitExceeded.IdentityFull | 身份提供商已达到上限。 |