接口请求域名： organization.intl.tencentcloudapi.com 。
配置SAML身份提供商信息
默认接口请求频率限制：20次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：SetExternalSAMLIdentityProvider。 |
| Version | 是 | String | 公共参数，本接口取值：2021-03-31。 |
| Region | 否 | String | 公共参数，此参数为可选参数。 |
| ZoneId | 是 | String | 空间ID。 |
| EncodedMetadataDocument | 否 | String | IdP 元数据文档（Base64 编码）。 由支持 SAML 2.0 协议的 IdP 提供。 |
| SSOStatus | 否 | String | SSO 登录的启用状态。取值： Enabled：启用。 Disabled（默认值）：禁用。 |
| EntityId | 否 | String | IdP 标识。 |
| LoginUrl | 否 | String | IdP 的登录地址。 |
| X509Certificate | 否 | String | PEM 格式的 X509 证书。指定该参数会替换所有已经存在的证书。 |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CertificateIds | Array of String | 证书ID。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
配置SAML身份提供商信息
POST / HTTP/1.1
Host: organization.intl.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"
}
}
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| 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证书格式错误。 |
文档反馈