1. 接口描述
接口请求域名： cam.tencentcloudapi.com 。
修改用户OIDC配置
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：UpdateUserOIDCConfig。 |
| Version | 是 | String | 公共参数，本接口取值：2019-01-16。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| IdentityUrl | 是 | String | 身份提供商URL。OpenID Connect身份提供商标识。 对应企业IdP提供的Openid-configuration中"issuer"字段的值，该URL必须以https开头，符合标准URL格式，不允许带有query参数（以?标识）、fragment片段（以#标识）和登录信息（以@标识）。 示例值：https://xulongliang.authing.cn/oidc |
| IdentityKey | 是 | String | RSA签名公钥，JWKS格式，需要进行base64_encode。验证OpenID Connect身份提供商ID Token签名的公钥。为了您的账号安全，建议您定期轮换签名公钥。 示例值：ewogICJrZXlzIjogWwogICAgewogICAgICAia3R5IjogIlJTQSIsCiAgICAgICJraWQiOiAibXlrZXkiLAogICAgICAidXNlIjogInNpZyIsCiAgICAgICJhbGciOiAiUlMyNTYiLAogICAgICAibiI6ICJBS2pKWnouLi4vZjEiLAogICAgICAiZSI6ICJBUUFCIgogICAgfQogIF0KfQ== |
| ClientId | 是 | String | 客户端ID，在OpenID Connect身份提供商注册的客户端ID，允许英文字母、数字、特殊字符.-:/，不能以特殊字符.-:/开头，单个客户端ID最大64个字符。 示例值：61adcf00620c31e3ddbc9546 |
| AuthorizationEndpoint | 是 | String | 授权请求Endpoint，OpenID Connect身份提供商授权地址。对应企业IdP提供的Openid-configuration中"authorization_endpoint"字段的值，该URL必须以https开头，符合标准URL格式，不允许带有query参数（以?标识）、fragment片段（以#标识）和登录信息（以@标识）。 示例值：https://console.authing.cn/console/get-started/61adcf00620c31e3d |
| ResponseType | 是 | String | 授权请求Response type，有code，id_token，固定值id_token。 示例值：id_token |
| ResponseMode | 是 | String | 授权请求Response mode。授权请求返回模式，有form_post和fragment两种可选模式，推荐选择form_post模式。 示例值：fragment |
| MappingFiled | 是 | String | 映射字段名称。IdP的id_token中哪一个字段映射到子用户的用户名，通常是sub或者name字段,仅支持英文字母、数宇、汉字、符号@、＆_[]-的组合，1-255个中文或英文字符 示例值：sub |
| Scope.N | 否 | Array of String | 授权请求Scope。有openid; email;profile三种。代表授权请求信息范围openid表示请求访问用户的身份信息，email表示请求访问用户的电子邮件地址，profile表示请求访问用户的基本信息。默认必选openid。 示例值：openid |
| Description | 否 | String | 描述，长度为1~255个英文或中文字符，默认值为空。 示例值：描述 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改用户OIDC配置
输入示例
POST / HTTP/1.1
Host: cam.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: UpdateUserOIDCConfig
<公共请求参数>
{
"ResponseType": "id_token",
"IdentityUrl": "https://tencent.auth**.com",
"ResponseMode": "form_post",
"Description": "描述",
"IdentityKey": "key",
"ClientId": "cbaefefes9823***",
"MappingFiled": "sub",
"AuthorizationEndpoint": "https://tencent.auth**.com",
"Scope": [
"email"
]
}输出示例
{
"Response": {
"RequestId": "10a20884-070e-48a8-aa40-9ed295a33ea2"
}
}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.IdentityKeyError | OIDC签名公钥错误。 |
| InvalidParameterValue.IdentityUrlError | 身份提供商URL错误。 |
| InvalidParameterValue.MetadataError | 身份提供商元数据文档错误。 |
| LimitExceeded.IdentityFull | 身份提供商已达到上限。 |
| ResourceNotFound.IdentityNotExist | 身份提供商不存在。 |