AddExternalSAMLIdPCertificate

Last Updated At: 2026-08-02 00:04:53

1. Interface Description

Interface request domain name: cic.api3.convergecloud.com.

This API is used to add SAML signing certificates.

Default interface request rate limit: 20 times per second.

Interface update time: 2024-12-11 12:17:58.

The interface is both signature verification and authentication.

2. Input Parameters

The following list of request parameters only lists interface request parameters and some public parameters, For a complete list of public parameters see public request parameters.

Parameter name Required Allow NULL Type Description
Action Yes No String Public parameter, The value of this interface: AddExternalSAMLIdPCertificate
Version Yes No String Public parameter, The value of this interface: 2021-03-31
Region No No String Public parameter,Regional information This interface does not need to pass this parameter.
X509Certificate Yes Yes String X509 certificate in PEM format, provided by the SAML identity provider.
Example: MIIBtjCCAVugAwIBAgI*****
ZoneId Yes Yes String Space ID.
Example: z-necd***

3. Output Parameters

Parameter name Type Description
CertificateId String SAML signing certificate ID.
Example: idp-c-2jd8923je29****
RequestId String Unique request id, Each request will return. The RequestId of the request needs to be provided when locating the problem.

4. Error Code

The following lists only the error codes related to the interface business logic, For other error codes, see public ErrorCode.

Error Code Description
InvalidParameterValue.X509CertificateFormatError
FailedOperation.X509CertificateAlreadyExist
FailedOperation.X509CertificateParsingFailed
FailedOperation.DBOperationError
InternalError