kz.arta.synergy.api.rest.admin

Class UsersService

java.lang.Object

kz.arta.synergy.api.rest.admin.UsersService

public class UsersService
extends java.lang.Object

User: vsl Date: 3/25/16 Time: 9:04 AM апи для управления сессиями пользователя

Constructor Summary

Constructors

Constructor and Description
UsersService()

Method Summary

Methods

Modifier and Type	Method and Description
Response	listLoggedInUsers(java.lang.String showIdsStr) Получение залогиненных пользователей URL: /rest/api/admin/user/logged_in Тип: GET
Response	logout(java.util.List<java.lang.String> users) Принудительное разлогинивание пользователей URL: /rest/api/admin/user/log_out Тип: POST Данный метод доступен только пользователям с правами суперадминистратора.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UsersService

public UsersService()

Method Detail

logout

public Response logout(java.util.List<java.lang.String> users)

Принудительное разлогинивание пользователей

URL: /rest/api/admin/user/log_out

Тип: POST

Данный метод доступен только пользователям с правами суперадминистратора.

Parameters:

Метод - принимает на входе массив строк, которые являются идентификаторами пользователей, которых необходимо разлогинить(обяз.).

Пример запроса:

POST / HTTP/1.1 Host: localhost:8389 Cache-Control: no-cache Content-Type: application/json [ "4da20e1f-49a9-4965-8736-8548896462ea", "1168cdf5-02c5-4f45-8141-2921f1165b68", "8c065606-05f7-4ad9-b7dd-02be1be18e6b" ]

Returns:

Пример ответа при успешном выполнении метода:

{ "errorCode": 0, "errorMessage":"Сессии пользователей принудительно завершены" }

listLoggedInUsers

public Response listLoggedInUsers(java.lang.String showIdsStr)

Получение залогиненных пользователей

URL: /rest/api/admin/user/logged_in

Тип: GET

Parameters:

Метод - принимает следующий входной параметр:

• showLoggedIn - признак необходимости возврата списка пользователей (по умолчанию false). Принимает следующие значения:
  • true - возвращает список залогиненных пользователей
  • false - не возвращает список залогиненных пользователей

Пример запроса:

/rest/api/admin/user/logged_in?showLoggedIn=true

Returns:

В случае успешного выполнения метод возвращает объект JSON с полями:

• number - количество залогиненных пользователей
• users - массив, состоящий из идентификаторов пользователей. При showLoggedIn=false, возвращается пустой массив

Пример ответа при успешном выполнении:

{ "number" : 5, "users": [ "8b86eb00-e062-11e5-8c91-525400bb7fc6", "088565c0-e025-11e5-8c91-525400bb7fc6", "9b3dd2d0-dec2-11e5-8c91-525400bb7fc6", "86865eb0-a3d6-11e5-9ae6-525400bb7fc6", "50acca20-c8c2-11e5-92a8-525400bb7fc6" ] }