Tenant Cloud
Management and Audit
Cloud Organization
Identity Center Single Sign-On Management APIs
SetExternalSAMLIdentityProvider
1. Interface Description
Interface request domain name: cic.api3.convergecloud.com.
This API is used to configure the SAML identity provider information.
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: SetExternalSAMLIdentityProvider |
| 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. |
| EntityId | No | Yes | String | IdP identifier. Example: http://www.okta.com/2jd*** |
| LoginUrl | No | Yes | String | IdP login URL. Example: https://dev***.okta.com |
| X509Certificate | No | Yes | String | X509 certificate in PEM format. If this parameter is specified, all existing certificates will be replaced. Example: MIIBtjCCAVugAwIBAgIT*** |
| ZoneId | Yes | Yes | String | Space ID. Example: z-2d8shd8*** |
| EncodedMetadataDocument | No | Yes | String | IdP metadata document (Base64 encoded). Provided by an IdP that supports the SAML 2.0 protocol. Example: PD94bWwgdmVyc2lvbj0iM*** |
| SSOStatus | No | Yes | String | SSO enabling status. Valid values: Enabled, Disabled (default). Example: Enabled |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| 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.UploadMetadataFailed | |
| InvalidParameterValue.SSoStatusInvalid | |
| FailedOperation.SAMLServiceProviderCreateFailed | |
| FailedOperation.XMLDataUnmarshalFailed | |
| FailedOperation.DecodeMetadataDocumentFailed | |
| FailedOperation.X509CertificateParsingFailed | |
| FailedOperation.MetadataCosParsingFailed | |
| FailedOperation.DBOperationError | |
| InternalError |