Page tree
Skip to end of metadata
Go to start of metadata
This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors.

The information on this page applies to iSymphony 3.2+.

Description

The live login REST resource allows access to information about active user logins in the system. Every active client session will have a relative login. There are currently no actions that can be performed on a login.

On this page:

 


JSON Representation

{
  "id": "40428554-6389-4641-8f49-d09c84b37cfb",
  "ip": "127.0.0.1",
  "port": 52237,
  "timeConnected": 1436471084211
}
PropertyTypeDescription
id
StringThe id of the login.
ip
StringThe ip address the user logged in from.
port
IntegerThe local port on the user's machine used to log in.
timeConnected
LongThe time the user logged into the system. Represented as a unix timestamp, in milliseconds.

Root Resource Paths

Paths used to access sets of the resource, in relation to parent resources.

communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/users/[{user_id} | getByName/{username}]/logins
Description

Provides access to all active logins for the specified user.

Parameters:

  • core_server_id: the id of the parent core server
  • core_server_slug: the slug of the parent core server
  • user_id: the id of the parent user
  • user_name: the username of the parent user

Errors:

  • 404 Not Found: Returned if no core server with the given id or slug exists
  • 404 Not Found: Returned if no user with the given id or username exists
GETGets all user logins for the specified user.

Instance Resource Paths

Paths used to access a specific instance of the resource.

{root_resource path}/{login_id}
Description

Provides access to a specified login, by id.

Parameters:

  • root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above
  • login_id: the id of the user login to access

Errors:

  • 404 Not Found: Returned if any of the ancestors in the root resource path could not be found
  • 404 Not Found: Returned if no login with the given id exists
GETGets the specified user login.

Curl Examples

Gets all user logins for a user

curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/users/40428554-6389-4641-8f49-d09c84b37cfb/logins

Get a specific user login for a user

curl --user manager:manag3rpa55word -i -H "Accept: application/json" http://localhost:58080/communication_manager/rest/live/coreServers/ca5de6c4-17bd-46ce-95a2-8b29c7812ca4/users/40428554-6389-4641-8f49-d09c84b37cfb/logins/e2ecf31f-4b29-4e3d-8cdf-9b9998d12002
  • No labels