Help Center/ IAM Identity Center/ API Reference/ API/ Application Management/ Updating Schema Attribute Mapping Configurations of an Application
Updated on 2025-08-21 GMT+08:00

Updating Schema Attribute Mapping Configurations of an Application

Function

This API is used to update schema attribute mapping configurations of an application to support Subject attribute mapping and the Subject NameID format in SAML assertions. 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-schema-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_schema_config

Yes

ResponseSchemaConfigDto object

Configuration for application schema attribute mapping.

Table 4 ResponseSchemaConfigDto

Parameter

Mandatory

Type

Description

properties

No

Map<String,ResponseSchemaPropertiesDetailsDto>

Additional schema configuration for attribute mapping.

subject

Yes

ResponseSchemaSubjectDetailsDto object

Schema configuration for subject attribute mapping.

supported_name_id_formats

No

Array of strings

Subject NameID format supported by an application.

Table 5 ResponseSchemaPropertiesDetailsDto

Parameter

Mandatory

Type

Description

attr_name_format

Yes

String

Additional attribute format.

include

Yes

String

Whether additional attributes are included.

Table 6 ResponseSchemaSubjectDetailsDto

Parameter

Mandatory

Type

Description

name_id_format

Yes

String

NameID format.

include

Yes

String

Whether NameID is included.

Response Parameters

Status code: 200

Successful

Status code: 400

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.

Status code: 403

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.

encoded_authorization_message

String

Encrypted error message.

Status code: 404

Table 9 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 schema attribute mapping configurations of an application to support Subject attribute mapping and the Subject NameID format in SAML assertions

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

{
  "response_schema_config" : {
    "properties" : { },
    "subject" : {
      "name_id_format" : "nameid-format:unspecified",
      "include" : "REQUIRED"
    },
    "supported_name_id_formats" : [ "nameid-format:unspecified" ]
  }
}

Example Response

None

Status Codes

Status Code

Description

200

Successful.

400

Bad request.

403

Forbidden.

404

Not found.

Error Codes

For details, see Error Codes.