RGolovanov: Новая страница: «Этот вызов API получает сеансы пользователей на основе определенного идентификатора пол...»

2022-09-22T15:14:16Z

Новая страница: «Этот вызов API получает сеансы пользователей на основе определенного идентификатора пол...»

Новая страница

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

==Аутентификация==
Для выполнения этого запроса вам необходимо разрешение API <code>(ServiceProviderAPI)</code>, назначенное вашему токену API. Создайте свой токен API с помощью консоли управления кластером (CMC). Чтобы узнать, как его получить и использовать, см. [https://doc.ruscomtech.ru/index.php/%D0%90%D1%83%D1%82%D0%B5%D0%BD%D1%82%D0%B8%D1%84%D0%B8%D0%BA%D0%B0%D1%86%D0%B8%D1%8F_%D0%BA%D0%BB%D0%B0%D1%81%D1%82%D0%B5%D1%80%D0%B0 Аутентификация кластера].
==Конечная точка==
<code>/api/cluster/v2/userSessions</code>
==Параметры==
{| class="wikitable"
!Параметр
!Тип
!Описание
!В
!Обязательно
|-
|userId
|string
|Идентификатор пользователя
|query
|Нет
|}

==Ответ==
===Коды ответа===
{| class="wikitable"
!Код
!Тип
!Описание
|-
|'''200'''
|UserSession[]
|Успешно
|-
|'''500'''
|
|Операция не удалась
|}
===Объекты тела ответа===
====Объект <code>UserSession</code>====
{| class="wikitable"
!Элемент
!Тип
!Описание
|-
|userId
|string
|ID пользователя
|-
|nodeId
|integer
|Нода, на которой существует сеанс пользователя
|-
|sessionId
|string
|Идентификатор сеанса пользователя
|-
|creationTime
|integer
|Отметка времени создания сеанса пользователя
|-
|lastAccessedTimestamp
|integer
|Отметка времени, когда сеанс был недавно открыт
|-
|tenantUuid
|string
|UUID арендатора, в который вошел пользователь (или UUID кластера, если пользователь вошел в CMC)
|-
|loginType
|string
|Как пользователь вошел в систему

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

* <code>LOCAL</code>
* <code>LDAP</code>
* <code>SSO_MANAGED</code>
* <code>DEVOPSTOKEN</code>
|-
|device
|string
|Устройство, на котором пользователь вошел в систему
|-
|ip
|string
|IP, с которого заходил пользователь
|}
====JSON-модель тела ответа====
<code>[
{
"userId": "string",
"nodeId": 1,
"sessionId": "string",
"creationTime": 1,
"lastAccessedTimestamp": 1,
"tenantUuid": "string",
"loginType": "LOCAL",
"device": "string",
"ip": "string"
}
]</code>
==Пример==
В этом примере запрос перечисляет сеансы пользователей в кластере <code>myManaged.cluster.com</code> для пользователя <code>user.name</code>.
====Curl====
<code>curl -X GET "<nowiki>https://myManaged.cluster.com/api/cluster/v2/userSessions?userId=user.name</nowiki>" -H "accept: application/json"</code>
====URL-адрес запроса====
<code><nowiki>https://myManaged.cluster.com/api/cluster/v2/userSessions?userId=user.name</nowiki></code>
====Тело ответа====
<code>[
{
"userId": "user.name",
"nodeId": 4,
"sessionId": "string",
"creationTime": 0,
"lastAccessedTimestamp": 0,
"tenantUuid": "string",
"loginType": "LOCAL",
"device": "string",
"ip": "string"
}
]</code>
====Код ответа====
<code>200</code>

Получение списка сессий - История изменений

RGolovanov: Новая страница: «Этот вызов API получает сеансы пользователей на основе определенного идентификатора пол...»