principal list#

Возвращает список принципалов.

Синтаксис#

catalog principal list
  [--principal-type=<principalType>] 
  [--page-size=<pageSize>]
  [--page-token=<pageToken>]

Опции#

--principal-type Тип принципала. Допустимые значения: user — пользователь; role — роль.

--page-size Максимальное количество возвращаемых записей.

--page-token Идентификатор страницы, начиная с которой необходимо возвращать записи.

Контроль доступа#

Пользователь, выполняющий операцию, должен быть иметь права на выполнение следующих действий:

principal.list

Примеры#

Получить список принципалов с отображением в табличном формате:

catalog principal list

+----------------+----------------+-------+--------+---------------+------------------------------------+
| principal-name | principal-type | owner | active | role-names    | properties                         |
+----------------+----------------+-------+--------+---------------+------------------------------------+
| root           | user           | root  | true   | builtin.admin |                                    |
| john           | user           | root  |        |               | department=ENG;email=john@work.com |
| jane           | user           | root  | true   |               | department=HR;email=jane@work.com  |
+----------------+----------------+-------+--------+---------------+------------------------------------+

Получить список принципалов с разбиением на страницы:

catalog principal list --page-size 2

+----------------+----------------+-------+--------+---------------+------------------------------------+
| principal-name | principal-type | owner | active | role-names    | properties                         |
+----------------+----------------+-------+--------+---------------+------------------------------------+
| root           | user           | root  | true   | builtin.admin |                                    |
| john           | user           | root  | true   |               | department=ENG;email=john@work.com |
+----------------+----------------+-------+--------+---------------+------------------------------------+
Next page token: 9e5bad44-e01f-4e93-bf23-38118f96357e

Получить следующую страницу результатов с отображением в формате JSON

catalog --json principal list --page-size 2 --page-token 9e5bad44-e01f-4e93-bf23-38118f96357e

{
  "items" : [ {
    "principalName" : "jane",
    "principalType" : "user",
    "owner": "root",
    "active" : true,
    "role-names" : [  ],
    "properties" : {
      "email" : "jane@work.com",
      "department" : "HR"
    }
  } ],
  "next-page-token" : null
}