Получение списка пользователей: различия между версиями

Материал из Документация Ключ-АСТРОМ
 
Строка 1: Строка 1:
'''''[https://doc.ruscomtech.ru/index.php/%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D0%B8_%D0%BD%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0 Установка и настройка] / [https://doc.ruscomtech.ru/index.php/%D0%A3%D1%81%D1%82%D0%B0%D0%BD%D0%BE%D0%B2%D0%BA%D0%B0_%D0%B8_%D0%BD%D0%B0%D1%81%D1%82%D1%80%D0%BE%D0%B9%D0%BA%D0%B0#.D0.9E.D1.81.D0.BD.D0.BE.D0.B2.D0.BD.D1.8B.D0.B5_.D1.8D.D0.BB.D0.B5.D0.BC.D0.B5.D0.BD.D1.82.D1.8B_.D0.9A.D0.BB.D1.8E.D1.87-.D0.90.D1.81.D1.82.D1.80.D0.BE.D0.BC Основные элементы Ключ-Астром] / [https://doc.ruscomtech.ru/index.php/%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C_Managed Ключ-АСТРОМ Managed] / [https://doc.ruscomtech.ru/index.php/%D0%9A%D0%BB%D1%8E%D1%87-%D0%90%D0%A1%D0%A2%D0%A0%D0%9E%D0%9C_Managed#REST_API REST API] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0_v1 API Кластера v1] / [https://doc.ruscomtech.ru/index.php/API_%D0%9A%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0_v1#.D0.9F.D0.BE.D0.BB.D1.8C.D0.B7.D0.BE.D0.B2.D0.B0.D1.82.D0.B5.D0.BB.D0.B8 Пользователи] / Получение списка пользователей'''''
Этот вызов API извлекает список пользователей кластера.
Этот вызов API извлекает список пользователей кластера.
==Аутентификация==
==Аутентификация==

Текущая версия на 14:15, 18 августа 2023

Установка и настройка / Основные элементы Ключ-Астром / Ключ-АСТРОМ Managed / REST API / API Кластера v1 / Пользователи / Получение списка пользователей

Этот вызов API извлекает список пользователей кластера.

Аутентификация

Для выполнения этого запроса вам необходимо разрешение API (ServiceProviderAPI), назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. Аутентификация кластера.

Конечная точка

/api/v1.0/onpremise/users

Параметры

Запрос не предоставляет никаких настраиваемых параметров.

Ответ

Коды ответа

Код Тип Описание
200 UserConfig[] Success

Объекты тела ответа

Объект ResponseBody

Объект не предоставляет никаких параметров.

Объект UserConfig

Конфигурация пользователя.

Элемент Тип Описание
id string ID пользователя
email string Адрес электронной почты пользователя
firstName string Имя пользователя
lastName string Фамилия пользователя
passwordClearText string Пароль пользователя открытым текстом; используется только для установки начального пароля
groups string[] Список идентификаторов групп пользователей пользователя.

JSON-модель тела ответа

[
  {
    "id": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "passwordClearText": "string",
    "groups": [
      "string"
    ]
  }
]

Пример

В этом примере вы извлекаете всех пользователей кластера. Для каждого пользователя вы получаете подробную информацию и членство в группах.

Curl

curl -X GET "https://myManaged.cluster.com/api/v1.0/onpremise/users" -H  "accept: application/json"

URL-адрес запроса

https://myManaged.cluster.com/api/v1.0/onpremise/users

Тело ответа

[
  {
    "id": "john.wicked",
    "email": "john.wicked@company.com",
    "firstName": "John",
    "lastName": "Wicked",
    "passwordClearText": null,
    "groups": [
      "owners",
      "users"
    ]
  },
  {
    "id": "anne.brown",
    "email": "anne.brown@company.com",
    "firstName": "Anne",
    "lastName": "Brown",
    "passwordClearText": null,
    "groups": ["users"]
  }
]

Код ответа

200

Источник — https://doc.ruscomtech.ru/index.php?title=Получение_списка_пользователей&oldid=3072