Help Center/ IAM Identity Center/ API Reference/ API/ Application Management/ Updating Display Information of an Application Instance

Updated on 2025-08-21 GMT+08:00

View PDF

Updating Display Information of an Application Instance

Function

This API is used to update the display information of an application instance. 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}/display-data

**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-.

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.

**Table 3** Parameters in the request body
Parameter	Mandatory	Type	Description
description	Yes	String	Application description.
display_name	Yes	String	Application display name.

Response Parameters

Status code: 200

Successful

Status code: 400

**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.

Status code: 403

**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.
encoded_authorization_message	String	Encrypted error message.

Example Request

Updating display information of an application instance

PUT https://{hostname}/v1/instances/{instance_id}/application-instances/{application_instance_id}/display-data

{
  "display_name" : "Custom SAML 2.0 application",
  "description" : "test"
}