接口描述
本接口(UpdateSAMLProvider)用于更新 SAML 身份提供商描述或元数据文档。
请求域名:cam.api.qcloud.com
请求方式:HTTP POST
输入参数
以下请求参数列表仅列出了接口请求参数,其余公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
name | 是 | String | SAML 身份提供商名称。 |
desc | 否 | String | 身份提供商描述。 |
SAMLMetadataDocument | 否 | String | SAML 身份提供商元数据文档。需要以Base64 编码,支持最大数据为 64KB。 |
备注:若 IdP 元数据文档超过最大限制,可删除元数据 XML 文档中除 IDPSSODescriptor 外的其他 XML 节点。
输出参数
暂无。
示例
更新名称为 IdP 的 SAML 身份提供商描述,以及元数据文档。
输入示例:
POST /v2/index.php HTTP/1.1
Host: cam.api.qcloud.com
Accept: */*
Content-Length: 3927
Content-Type: application/x-www-form-urlencoded
Action=UpdateSAMLProvider&name=idp&SAMLMetadataDocument=U0FNTE1ldGFkYXRhRG9jdW1lbnQgdjI=&desc=descriptor2&<公共请求参数>
输出示例:
{
"code": 0,
"message": "",
"codeDesc": "Success",
"data": [
]
}
错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InvalidParameter.ProviderNotExist | 身份提供商不存在。 |
InvalidParameter.SAMLMetadataDocument | SAML 身份提供商元数据文档错误。 |