配置SAML身份提供商信息

最近更新时间: 2026-10-12 00:11:05

1. 接口描述

接口请求域名： cic.api3.fincloud.tencent.com。

配置SAML身份提供商信息

默认接口请求频率限制：20次/秒。

接口更新时间：2024-12-11 12:17:58。

接口既验签名又鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：SetExternalSAMLIdentityProvider
Version	是	否	String	公共参数，本接口取值：2021-03-31
Region	是	否	String	公共参数，地域信息本接口不需要传递此参数。
EntityId	否	是	String	IdP 标识。示例值： http://www.okta.com/2jd***
LoginUrl	否	是	String	IdP 的登录地址。示例值： https://dev***.okta.com
X509Certificate	否	是	String	PEM 格式的 X509 证书。指定该参数会替换所有已经存在的证书。示例值： MIIBtjCCAVugAwIBAgIT***
ZoneId	是	是	String	空间ID。示例值： z-2d8shd8***
EncodedMetadataDocument	否	是	String	IdP 元数据文档（Base64 编码）。由支持 SAML 2.0 协议的 IdP 提供。示例值： PD94bWwgdmVyc2lvbj0iM***
SSOStatus	否	是	String	SSO 登录的启用状态。取值： Enabled：启用。 Disabled（默认值）：禁用。示例值： Enabled

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InvalidParameterValue.X509CertificateFormatError
FailedOperation.UploadMetadataFailed
InvalidParameterValue.SSoStatusInvalid
FailedOperation.SAMLServiceProviderCreateFailed
FailedOperation.XMLDataUnmarshalFailed
FailedOperation.DecodeMetadataDocumentFailed
FailedOperation.X509CertificateParsingFailed
FailedOperation.MetadataCosParsingFailed
FailedOperation.DBOperationError
InternalError

5. 示例

示例1 配置SAML身份提供商信息

输入示例

{
  "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"
  }
}