文档首页/ IAM 身份中心/ API参考/ API/ 应用程序管理/ 更新应用程序Schema属性映射配置
更新时间:2025-08-14 GMT+08:00
分享

更新应用程序Schema属性映射配置

功能介绍

更新应用程序Schema属性映射配置,支持SAML断言中Subject属性映射以及Subject NameID格式。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

String

IAM Identity Center实例的全局唯一标识符(ID)

application_instance_id

String

应用程序实例ID,以app-ins-为前缀

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

String

如果正在使用临时安全凭据,则此header是必需的,该值是临时安全凭据的安全令牌(会话令牌)。

表3 请求Body参数

参数

是否必选

参数类型

描述

response_schema_config

ResponseSchemaConfigDto object

应用程序Schema属性映射配置

表4 ResponseSchemaConfigDto

参数

是否必选

参数类型

描述

properties

Map<String,ResponseSchemaPropertiesDetailsDto>

额外添加的属性映射Schema配置

subject

ResponseSchemaSubjectDetailsDto object

Subject属性映射Schema配置

supported_name_id_formats

Array of strings

应用程序支持的Subject NameID格式

表5 ResponseSchemaPropertiesDetailsDto

参数

是否必选

参数类型

描述

attr_name_format

String

额外添加的属性的格式

include

String

是否包含额外属性

表6 ResponseSchemaSubjectDetailsDto

参数

是否必选

参数类型

描述

name_id_format

String

NameID的格式

include

String

是否包含NameID

响应参数

状态码:200

Successful

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

request_id

String

请求唯一标识

状态码:403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

request_id

String

请求唯一标识

encoded_authorization_message

String

加密的错误信息

状态码:404

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

request_id

String

请求唯一标识

请求示例

更新应用程序Schema属性映射配置,支持SAML断言中Subject属性映射以及Subject NameID格式。

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" ]
  }
}

响应示例

状态码

状态码

描述

200

Successful

400

Bad request

403

Forbidden

404

Not found

错误码

请参见错误码

相关文档