Updating Application Attribute Configurations

Function

This API is used to update application attribute configurations, including the attribute mapping, relay state, and session expiration time in the application. 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}/response-configuration

**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
response_config	Yes	ResponseConfigDto object	Application attribute configuration.

**Table 4** ResponseConfigDto
Parameter	Mandatory	Type	Description
properties	No	Map<String,ResponseSourceDetailsDto>	Additional configuration for attribute mapping.
subject	No	ResponseSourceDetailsDto object	Subject attribute mapping configuration.
relay_state	No	String	Relay state.
ttl	Yes	String	Session expiration time.

**Table 5** ResponseSourceDetailsDto
Parameter	Mandatory	Type	Description
source	Yes	Array of strings	Attribute mapping value.

Response Parameters

Status code: 200

Successful

Status code: 400

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

Status code: 403

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

Status code: 404

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

Updating application attribute configurations, including the attribute mapping, relay state, and session expiration time in the application

PUT https://{hostname}/v1/instances/{instance_id}/application-instances/{application_instance_id}/response-configuration

{
  "response_config" : {
    "properties" : {
      "username" : {
        "source" : [ "${user:familyName}" ]
      }
    },
    "subject" : {
      "source" : [ "${user:email}" ]
    },
    "relay_state" : null,
    "ttl" : "PT1H"
  }
}