Help Center/ IAM Identity Center/ API Reference/ API/ Application Certificate Management/ Activating Application Instance Certificates
Updated on 2025-11-27 GMT+08:00
View PDF

Activating Application Instance Certificates

Function

This API is used to activate application instance certificates to implement certificate rotation. It can be called only from the organization's management account or from a delegated administrator account of a cloud service.

URI

PUT /v1/instances/{instance_id}/application-instances/{application_instance_id}/certificates/{certificate_id}

Table 1 Path parameters

Parameter

Mandatory

Type

Description

instance_id

Yes

String

Globally unique ID of an IAM Identity Center instance.

application_instance_id

Yes

String

Application instance ID. Its prefix is app-ins-.

certificate_id

Yes

String

Globally unique ID of an application certificate.

Request Parameters

Table 2 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

Table 3 Parameters in the response body

Parameter

Type

Description

application_instance_certificate

CertificateDto object

Application certificate.
Table 4 CertificateDto

Parameter

Type

Description

algorithm

String

Certificate generation algorithm.

certificate

String

Application certificate.

certificate_id

String

Application certificate ID.

expiry_date

Long

Certificate expiration time.

status

String

Certificate status.

key_size

String

Key size.

issue_date

Long

Certificate generation time.

Status code: 400

Table 5 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 6 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: 404

Table 7 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

Activating application instance certificates to implement certificate rotation

PUT https://{hostname}/v1/instances/{instance_id}/application-instances/{application_instance_id}/certificates/{certificate_id}

Example Response

Status code: 200

Successful

{
  "application_instance_certificate" : {
    "algorithm" : "SHA256withRSA",
    "certificate" : "certificate text",
    "certificate_id" : "cer-5c81c5ce-c16c-4a5d-8e55-f491f2239f1a",
    "expiry_date" : 1767916800000,
    "status" : "ACTIVE",
    "key_size" : "3072",
    "issue_date" : 1752048619976
  }
}

Status Codes

Status Code

Description

200

Successful.

400

Bad request.

403

Forbidden.

404

Not found.

Error Codes

For details, see Error Codes.