获取指定实例的访问控制属性配置 - DescribeInstanceAccessControlAttributeConfiguration

功能介绍

返回已配置为与指定IAM身份中心实例的基于属性的访问控制（ABAC）一起使用的IAM身份中心身份源属性列表。此操作只能由组织的管理账号或作为服务委托管理员的成员账号调用。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
IdentityCenter:instance:describeInstanceAccessControlAttributeConfiguration	Read	instance *	-	-	organizations:delegatedAdministrators:list

URI

GET /v1/instances/{instance_id}/access-control-attribute-configuration

表1 路径参数
参数	是否必选	参数类型	描述
instance_id	是	String	IAM身份中心实例的全局唯一标识符（ID）。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Security-Token	否	String	如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。最大长度：2048

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
instance_access_control_attribute_configuration	Object	已添加到ABAC配置的IAM身份中心身份源属性的列表。
status	String	ABAC属性配置的状态。枚举值： ENABLED：启用ABAC功能成功 CREATION_IN_PROGRESS：正在启用ABAC功能 CREATION_FAILED：启用ABAC功能失败
status_reason	String	提供有关指定属性的当前状态的更多详细信息。

表4 instance_access_control_attribute_configuration
参数	参数类型	描述
access_control_attributes	Array of objects	IAM身份中心实例中ABAC配置的属性。数组长度：0 - 20

表5 access_control_attributes
参数	参数类型	描述
key	String	与您的身份源中的身份关联的属性的名称。最小长度：1 最大长度：128
value	Object	用于将指定属性映射到身份源的值。

表6 value
参数	参数类型	描述
source	Array of strings	用于将指定属性映射到身份源的值。最小长度：0 最大长度：255 数组长度：1-1

状态码： 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	加密的错误信息

请求示例

获取指定实例的访问控制属性配置。

GET https://{hostname}/v1/instances/{instance_id}/access-control-attribute-configuration

响应示例

状态码： 200

Successful

{
  "instance_access_control_attribute_configuration" : {
    "access_control_attributes" : [ {
      "key" : "email",
      "value" : {
        "source" : [ "${path:emails[primary eq true].value}" ]
      }
    }, {
      "key" : "displayName",
      "value" : {
        "source" : [ "${path:displayName}" ]
      }
    } ]
  },
  "status" : "ENABLED",
  "status_reason" : null
}