更新时间:2024-04-10 GMT+08:00

列出权限集

功能介绍

查询指定实例下的权限集列表。

URI

GET /v1/instances/{instance_id}/permission-sets

表1 路径参数

参数

是否必选

参数类型

描述

instance_id

String

IAM身份中心实例的全局唯一标识符(ID)。

表2 Query参数

参数

是否必选

参数类型

描述

limit

Integer

每个请求返回的最大结果数。

最小值:1

最大值:100

缺省值:100

marker

String

分页标记。

最小长度:24

最大长度:24

permission_set_id

String

权限集的全局唯一标识符(ID)。

name

String

权限集名称。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

String

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

最大长度:2048

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

permission_sets

Array of objects

权限集列表。

page_info

Object

包含分页信息的对象。

表5 permission_sets

参数

参数类型

描述

created_date

Long

权限集的创建时间。

description

String

权限集的描述。

最小长度:1

最大长度:700

name

String

权限集的名称。

最小长度:1

最大长度:32

permission_set_id

String

权限集的唯一标识。

relay_state

String

用于在联合身份验证过程中重定向应用程序中的用户。

最小长度:1

最大长度:240

session_duration

String

应用程序用户会话在ISO-8601标准中有效的时间长度。

最小长度:1

最大长度:100

permission_urn

String

权限集的统一资源名称(URN)。

表6 page_info

参数

参数类型

描述

next_marker

String

如果存在,则表示可用的输出比当前响应中包含的输出多。在对操作的后续调用中,在标签请求参数中使用此值,以获取输出的下一部分。您应该重复此操作,直到next_marker响应元素返回为null。

current_count

Integer

本页返回条目数量。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

request_id

String

请求唯一标识。

状态码: 403

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

request_id

String

请求唯一标识。

请求示例

查询指定实例下的权限集列表。

GET https://{hostname}/v1/instances/{instance_id}/permission-sets

响应示例

状态码: 200

Successful

{
  "permission_sets" : [ {
    "created_date" : 1677175760379,
    "description" : "示例权限集1",
    "name" : "test_ps_1",
    "permission_set_id" : "ps-8603aaaaaaaa14bd",
    "relay_state" : "",
    "session_duration" : "PT4H",
    "permission_urn" : "IdentityCenter::system:permissionSet:ps-8603aaaaaaaa14bd"
  } ],
  "page_info" : {
    "next_marker" : "649040aaaaaaaaaaaa3e3050",
    "current_count" : 1
  }
}

状态码

请参见状态码

错误码

请参见错误码