Note：
This is a legacy API which has been hidden and will no longer be updated. We recommend using the new CAM API 3.0 which is standardized and faster.
This API (UpdateSAMLProvider) is used to update the description or the metadata document of a SAML IdP.
Request domain name: cam.api.qcloud.com
Request method: HTTP POST
The following request parameter list only provides API request parameters. Other common parameters can be found in Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| name | Yes | String | SAML IdP name |
| desc | No | String | IdP description |
| SAMLMetadataDocument | No | String | SAML IdP metadata document must be Base64 encoded, and its maximum size is 64 KB |
Note: If the IdP metadata document exceeds the file size limit, you can delete any of XML nodes except IDPSSODescriptor from the XML metadata document.
None.
Update the description and the metadata document of the SAML IdP named IdP.
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&<Common request parameters>{
"code": 0,
"message": "",
"codeDesc": "Success",
"data": [
]
}The following only lists the error codes related to this API. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InvalidParameter.ProviderNotExist | The IdP does not exist. |
| InvalidParameter.SAMLMetadataDocument | Invalid SAML IdP metadata document |
Was this page helpful?