Help Center/ IAM Identity Center/ API Reference/ API/ Instance Management/ Enabling an IAM Identity Center Instance
Updated on 2025-08-21 GMT+08:00

Enabling an IAM Identity Center Instance

Function

This API is used to enable an IAM Identity Center service instance. It can be called only from the organization's management account.

URI

POST /v1/service/start

Request Parameters

Table 1 Parameters in the request header

Parameter

Mandatory

Type

Description

X-Security-Token

No

String

Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Response Parameters

Status code: 200

Successful

Status code: 400

Table 2 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

Status code: 403

Table 3 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

encoded_authorization_message

String

Encrypted error message.

Status code: 409

Table 4 Parameters in the response body

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

request_id

String

Unique ID of a request.

Example Request

Enabling an IAM Identity Center service instance

POST https://{hostname}/v1/service/start

Example Response

None

Status Codes

Status Code

Description

200

Successful.

400

Bad request.

403

Forbidden.

409

Conflict.

Error Codes

For details, see Error Codes.