Получение списка сессий

Материал из Документация Ключ-АСТРОМ
Версия от 15:14, 22 сентября 2022; RGolovanov (обсуждение | вклад) (Новая страница: «Этот вызов API получает сеансы пользователей на основе определенного идентификатора пол...»)
(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)

Этот вызов API получает сеансы пользователей на основе определенного идентификатора пользователя. Вы можете запросить список пользовательских сеансов для определенного идентификатора пользователя в определенной среде.

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

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

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

/api/cluster/v2/userSessions

Параметры

Параметр Тип Описание В Обязательно
userId string Идентификатор пользователя query Нет

Ответ

Коды ответа

Код Тип Описание
200 UserSession[] Успешно
500 Операция не удалась

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

Объект UserSession

Элемент Тип Описание
userId string ID пользователя
nodeId integer Нода, на которой существует сеанс пользователя
sessionId string Идентификатор сеанса пользователя
creationTime integer Отметка времени создания сеанса пользователя
lastAccessedTimestamp integer Отметка времени, когда сеанс был недавно открыт
tenantUuid string UUID арендатора, в который вошел пользователь (или UUID кластера, если пользователь вошел в CMC)
loginType string Как пользователь вошел в систему

Элемент может содержать эти значения:

  • LOCAL
  • LDAP
  • SSO_MANAGED
  • DEVOPSTOKEN
device string Устройство, на котором пользователь вошел в систему
ip string IP, с которого заходил пользователь

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

[
  {
    "userId": "string",
    "nodeId": 1,
    "sessionId": "string",
    "creationTime": 1,
    "lastAccessedTimestamp": 1,
    "tenantUuid": "string",
    "loginType": "LOCAL",
    "device": "string",
    "ip": "string"
  }
]

Пример

В этом примере запрос перечисляет сеансы пользователей в кластере myManaged.cluster.com для пользователя user.name.

Curl

curl -X GET "https://myManaged.cluster.com/api/cluster/v2/userSessions?userId=user.name" -H  "accept: application/json"

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

https://myManaged.cluster.com/api/cluster/v2/userSessions?userId=user.name

Тело ответа

[
  {
    "userId": "user.name",
    "nodeId": 4,
    "sessionId": "string",
    "creationTime": 0,
    "lastAccessedTimestamp": 0,
    "tenantUuid": "string",
    "loginType": "LOCAL",
    "device": "string",
    "ip": "string"
  }
]

Код ответа

200