1. 接口描述
接口请求域名： organization.tencentcloudapi.com 。
配置SAML身份提供商信息
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：SetExternalSAMLIdentityProvider。 |
| Version | 是 | String | 公共参数，本接口取值：2021-03-31。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ZoneId | 是 | String | 空间ID。 示例值：z-2js923necd*** |
| EncodedMetadataDocument | 否 | String | IdP 元数据文档（Base64 编码）。 由支持 SAML 2.0 协议的 IdP 提供。 示例值：PD94bWwgdmVyc2lvbj0iMS4**** |
| SSOStatus | 否 | String | SSO 登录的启用状态。取值： Enabled：启用。 Disabled（默认值）：禁用。 示例值：Enabled |
| EntityId | 否 | String | IdP 标识。 示例值：http://www.okta.com/2jd83ne9m* |
| LoginUrl | 否 | String | IdP 的登录地址。 示例值：https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/2jd83ne9m****/sso/saml |
| X509Certificate | 否 | String | PEM 格式的 X509 证书。指定该参数会替换所有已经存在的证书。 示例值：MIIBtjCCAVugAwIBAgITBmyf1XSXNmY/Owua2eiedgPySjAKBggqhkjOPQQDAjA5*** |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 配置SAML身份提供商信息
配置SAML身份提供商信息
输入示例
POST / HTTP/1.1
Host: organization.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SetExternalSAMLIdentityProvider
<公共请求参数>
{
"ZoneId": "z-d3ideodm***",
"EncodedMetadataDocument": "JTNDJTNGeG1sJTIwdmVyc2lvbiUzRCUyMjEuMCUyMiUyMGVuY29kaW5******",
"SSOStatus": "Enabled",
"EntityId": "http://www.okta.com/xd83nd83nd****",
"LoginUrl": "https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/xd83nd83nd****/sso/saml",
"X509Certificate": "MIIC8DCCAdigAwIBAgIQP9eomUYGeoND****"
}输出示例
{
"Response": {
"RequestId": "2ccd7ed1-24b4-4882-8f4a-5580b430bce7"
}
}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.DecodeMetadataDocumentFailed | 解码元数据文档失败。 |
| FailedOperation.MetadataCosParsingFailed | idp原数据解析失败 |
| FailedOperation.SAMLServiceProviderCreateFailed | SAML服务提供商创建失败 |
| FailedOperation.UploadMetadataFailed | 上传数据文件失败。 |
| FailedOperation.X509CertificateParsingFailed | X509证书解析失败。 |
| FailedOperation.XMLDataUnmarshalFailed | 元数据文档解析XML失败。 |
| InternalError | 内部错误。 |
| InvalidParameterValue.SSoStatusInvalid | sso登录启用状态值非法 |
| InvalidParameterValue.X509CertificateFormatError | X509证书格式错误。 |
