Tenant Cloud
Management and Audit
Cloud Organization
Identity Center Single Sign-On Management APIs
GetZoneDetail
1. Interface Description
Interface request domain name: cic.api3.convergecloud.com.
This API is used to obtain the space information by space name.
Default interface request rate limit: 20 times per second.
Interface update time: 2024-12-25 16:08:59.
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: GetZoneDetail |
| 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. |
| ZoneName | Yes | Yes | String | Space name, which should be globally unique and contain 2–64 characters including lowercase letters, digits, and hyphens (-). It can neither start or end with a hyphen (-) nor contain two consecutive hyphens (-). Example: zone_name |
3. Output Parameters
| Parameter name | Type | Description |
|---|---|---|
| ServiceStatus | String | Service activation status. Disabled: not activated; Enabled: activated. Example: Enabled |
| SSOStatus | String | SSO login enabling status. Valid values: Disabled and Enabled. Example: Enabled |
| IdpLoginUrl | String | IdP login URL when SSO login is enabled. Example: ttp://www.okta.com/exke*** |
| IdpEntityID | String | idp entity ID. Example: http://www.okta.com/exk*** |
| SAMLRequest | String | Authentication request sent by the SP to the IdP. Example: PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTg*** |
| ZoneId | String | Space ID, which starts with the z- prefix, followed by 12 random digits/lowercase letters. Example: z-2d8shd8*** |
| 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 |
|---|---|
| FailedOperation.DBOperationError | |
| FailedOperation.IdentityCenterNotOpen | |
| FailedOperation.IdentityProviderNotConfigured |