tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

OpenIdentityCenter

Last updated: 2024-11-27 21:25:09

1. API Description

Domain name for API request: organization.intl.tencentcloudapi.com.

This API is used to activate Identity Center service (CIC).

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: OpenIdentityCenter.
Version Yes String Common Params. The value used for this API: 2021-03-31.
Region No String Common Params. This parameter is not required.
ZoneName Yes String Space name, which must 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 (-).

3. Output Parameters

Parameter Name Type Description
ZoneId String Space ID, which starts with the z- prefix, followed by 12 random digits/lowercase letters.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Activating Identity Center Service (CIC)

This example shows you how to activate Identity Center service (CIC).

Input Example

POST / HTTP/1.1
Host: organization.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: OpenIdentityCenter
<Common request parameters>



{
    "ZoneName": "testName"
}

Output Example

{
    "Response": {
        "ZoneId": "z-dj3jk*****",
        "RequestId": "e297543a-80de-4039-83c8-9d324f45"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.DBOperationError SQL execution error.
FailedOperation.IdentityCenterAlreadyOpen The CIC service has been activated.
FailedOperation.IdentityCenterNotAuth The user has not performed identity verification and cannot activate the CIC service.
FailedOperation.IdentityCenterNotEnterpriseAuth The user has not performed enterprise identity verification and cannot activate the CIC service.
FailedOperation.IdentityCenterNotOrganizationManager The user is not an admin of the Tencent Cloud Organization and cannot activate the CIC service.
FailedOperation.IdentityCenterOrganizationNotOpen The user has not activated Tencent Cloud Organization and cannot activate the CIC service.
InvalidParameterValue.IdentityCenterZoneNameAlreadyExist The CIC space name already exists. You should change the space name.
ResourceNotFound.ServiceRoleNotExist The organization service role does not exist.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
Privacy PolicyLegalCookie Policy