Wiki source code of Logins

Last modified by michaely on 2021/09/10 23:34
Show last authors
1 {{layout}}
2 {{layout-section ac:type="two_right_sidebar"}}
3 {{layout-cell}}
4 {{warning}}
5 This page is currently being written. Although the information below is probably accurate, it may not be complete or may have errors.
6 {{/warning}}
7
8 {{info}}
9 The information on this page applies to **iSymphony 3.2+**.
10 {{/info}}
11
12 = (% style="color: rgb(0,0,0);" %)Description(%%) =
13
14 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.
15 {{/layout-cell}}
16
17 {{layout-cell}}
18 {{panel title="On this page:"}}
19
20
21 {{toc maxLevel="2" indent="1"/}}
22 {{/panel}}
23 {{/layout-cell}}
24 {{/layout-section}}
25
26 {{layout-section ac:type="single"}}
27 {{layout-cell}}
28 (% style="color: rgb(0,0,0);" %)
29
30
31 = (% style="color: rgb(0,0,0);" %)JSON Representation(%%) =
32
33 {{code}}
34 {
35 "id": "40428554-6389-4641-8f49-d09c84b37cfb",
36 "ip": "127.0.0.1",
37 "port": 52237,
38 "timeConnected": 1436471084211
39 }
40 {{/code}}
41
42 |=(((
43 Property
44 )))|=(((
45 Type
46 )))|=(((
47 Description
48 )))
49 |(((
50 {{{id}}}
51 )))|(((
52 String
53 )))|(((
54 The id of the login.
55 )))
56 |(% colspan="1" %)(% colspan="1" %)
57 (((
58 {{{ip}}}
59 )))|(% colspan="1" %)(% colspan="1" %)
60 (((
61 String
62 )))|(% colspan="1" %)(% colspan="1" %)
63 (((
64 The ip address the user logged in from.
65 )))
66 |(% colspan="1" %)(% colspan="1" %)
67 (((
68 {{{port}}}
69 )))|(% colspan="1" %)(% colspan="1" %)
70 (((
71 Integer
72 )))|(% colspan="1" %)(% colspan="1" %)
73 (((
74 The local port on the user's machine used to log in.
75 )))
76 |(% colspan="1" %)(% colspan="1" %)
77 (((
78 {{{timeConnected}}}
79 )))|(% colspan="1" %)(% colspan="1" %)
80 (((
81 Long
82 )))|(% colspan="1" %)(% colspan="1" %)
83 (((
84 The time the user logged into the system. Represented as a unix timestamp, in milliseconds.
85 )))
86
87 = Root Resource Paths =
88
89 Paths used to access sets of the resource, in relation to parent resources.
90
91 |=(% colspan="2" %)(% colspan="2" %)
92 (((
93 {{{communication_manager/rest/live/coreServers/[{core_server_id} | getByName/{core_server_slug}]/users/[{user_id} | getByName/{username}]/logins}}}
94 )))
95 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
96 (((
97 **Description**
98 )))|(((
99 Provides access to all active logins for the specified user.
100
101 **Parameters:**
102
103 * core_server_id: the id of the parent core server
104 * core_server_slug: the slug of the parent core server
105 * user_id: the id of the parent user
106 * user_name: the username of the parent user
107
108 **Errors:**
109
110 * 404 Not Found: Returned if no core server with the given id or slug exists
111 * 404 Not Found: Returned if no user with the given id or username exists
112 )))
113 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
114 (((
115 **GET**
116 )))|(((
117 Gets all user logins for the specified user.
118 )))
119
120 = (% style="color: rgb(0,0,0);" %)Instance Resource Paths(%%) =
121
122 Paths used to access a specific instance of the resource.
123
124 (% style="line-height: 1.4285715;" %)
125 |=(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)(% class="highlight-grey" colspan="2" data-highlight-colour="grey" %)
126 (((
127 {{{{root_resource path}/{login_id}}}}
128 )))
129 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
130 (((
131 **Description**
132 )))|(((
133 Provides access to a specified login, by id.
134
135 **Parameters:**
136
137 * root_resource_path: One of the root resource paths for this resource. See Root Resource Paths above
138 * login_id: the id of the user login to access
139
140 **Errors:**
141
142 * 404 Not Found: Returned if any of the ancestors in the root resource path could not be found
143 * 404 Not Found: Returned if no login with the given id exists
144 )))
145 |(% class="highlight-grey" data-highlight-colour="grey" %)(% class="highlight-grey" data-highlight-colour="grey" %)
146 (((
147 **GET**
148 )))|(((
149 Gets the specified user login.
150 )))
151
152 = Curl Examples =
153
154 === Gets all user logins for a user ===
155
156 {{code language="bash"}}
157 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
158 {{/code}}
159
160 === Get a specific user login for a user ===
161
162 {{code language="bash"}}
163 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
164 {{/code}}
165 {{/layout-cell}}
166 {{/layout-section}}
167 {{/layout}}

Search

Navigation

iSymphony