Last modified by Андрей Калиновский on 2025/03/12 10:28
<
From version < 20.2 >
edited by Артем Шемяков
on 2022/09/01 17:08
To version < 20.5 >
edited by Артем Шемяков
on 2022/09/01 17:32
>
Change comment: There is no comment for this version

Summary

Details

Icon Page properties
Content
... ... @@ -34,8 +34,18 @@
34 34  (% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth».
35 35  
36 36  (% lang="en-US" %)
37 -(% style="color:#000000" %)**Ответ: [ { «AuthId»: «», //токен авторизации «User»: «», // имя пользователя }, … ]**
37 +(% style="color:#000000" %)**Ответ:**
38 38  
39 +(% lang="en-US" %)
40 +(% style="color:#000000" %){
41 +
42 +(% lang="en-US" %)
43 +(% style="color:#000000" %) "AuthId": "" , ~/~/ токен авторизации
44 + "User": "" , ~/~/ имя пользователя
45 +
46 +(% lang="en-US" %)
47 + }
48 +
39 39  **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется.
40 40  
41 41  
... ... @@ -82,16 +82,18 @@
82 82  
83 83  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
84 84  
85 -(% style="color:#000000" %)Ответ: [ {
86 - "agentId": "", ~/~/ идентификатор клиента
87 - "parentId": "", ~/~/ идентификатор клиента-родителя
88 - "name": "", ~/~/ наименование клиента
89 - "fullName": "", ~/~/ полное наименование клиента
90 - "agentInfoType": "", ~/~/ тип клиента1
91 - "status": "", ~/~/ статус клиента
92 - }, … ]
95 +(% style="color:#000000" %)Ответ:
93 93  
97 +(% style="color:#000000" %){
98 + "agentId": "", ~/~/ идентификатор клиента
99 + "parentId": "", ~/~/ идентификатор клиента-родителя
100 + "name": "", ~/~/ наименование клиента
101 + "fullName": "", ~/~/ полное наименование клиента
102 + "agentInfoType": "", ~/~/ тип клиента1
103 + "status": "", ~/~/ статус клиента
104 + }
94 94  
106 +
95 95  (% style="color:#000000" %)**Примечание:** возможные значение параметра agentInfoType: (% lang="en-US" %)[(% style="color:#000000; font-family:Liberation Serif,serif; font-size:12pt; font-style:normal; font-variant:normal; font-weight:normal" %)0 – Клиент, 1 – Партнер, 2 – Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - договор(% style="color:#000000" %)]
96 96  
97 97  
... ... @@ -113,12 +113,57 @@
113 113  
114 114  (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации
115 115  
116 -(% style="color:#000000" %)Параметры в теле запроса (JSON): { «lastName»: «», // фамилия «firstName»: «», // имя «position»: «», // должность «phone»: «», // телефон «organization»: «», // организация «login»: «», // логин «password»: «», // пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо) «email»: «», // email «description»: «», // описание «isEnabled»: «», // признак включения «parentId»: «», // Guid родительского агента «leaderId»: «», // Guid руководителя (null - не задан) «sessionDuration»: «», // продолжительность сессии, в минутах (null - по умолчанию, 30 минут) «doubleAuth»: { // параметры двухфакторной аутентификации «kind»: «», // тип аутентификации (None - выключена, Email - по email) «target»: «« // в случае аутентификации по email - email-адрес }, »groups»: [ // группы пользователя «», //названия групп «», «» ] }
128 +(% style="color:#000000" %)Параметры в теле запроса (JSON):
117 117  
130 +(% style="color:#000000" %){ 
131 + "lastName": "", ~/~/ фамилия
132 + "firstName": "", ~/~/ имя
133 + "position": "", ~/~/ должность
134 + "phone": "", ~/~/ телефон
135 + "organization": "", ~/~/ организация
136 + "login": "", ~/~/ логин
137 + "password": "", ~/~/ пароль (при добавлении - обязателен, при редактировании, если null - менять пароль не надо)
138 + "email": "", ~/~/ email
139 + "description": "", ~/~/ описание
140 + "isEnabled": "", ~/~/ признак включения
141 + "parentId": "", ~/~/ Guid родительского агента
142 + "leaderId": "", ~/~/ Guid руководителя (null - не задан)
143 + "sessionDuration": "", ~/~/ продолжительность сессии, в минутах (null - по умолчанию, 30 минут)
144 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
145 + "kind": "", ~/~/ тип аутентификации (None - выключена, Email - по email)
146 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес  
147 + "groups": "" , ~/~/ группы пользователя, названия групп
148 + }
149 +
118 118  (% style="text-align:left" %)
119 -(% style="color:#000000; font-weight:normal" %)Ответ: { «id»: «», //ID пользователя «lastName»: «», //Фамилия , «firstName»: «», //Имя «position»: «», //Должность «phone»: «», //Телефон «organization»: «», //Организация «login»: «», //Логин «password»: «», //Пароль «email»: «», //Email «description»: «», //Описание «isEnabled»: «», //Признак включения «parentId»: «», //Guid родительского агента «sessionDuration»: «», //Продолжительность сессии, в минутах «doubleAuth»: { //параметры двухфакторной аутентификации «kind»: «», //тип аутентификации «target»: «» //в случае аутентификации по email - email-адрес }, «groups»: [ // группы пользователя «user» //названия групп ] }
151 +(% style="color:#000000; font-weight:normal" %)Ответ:
120 120  
153 +(% style="text-align:left" %)
154 +(% style="color:#000000; font-weight:normal" %){
121 121  
156 +(% style="text-align:left" %)
157 +(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя
158 + "lastName": "" , ~/~/ Фамилия ,
159 + "firstName": "" , ~/~/ Имя
160 + "position": "" , ~/~/ Должность
161 + "phone": "" , ~/~/ Телефон
162 + "organization": "" , ~/~/ Организация
163 + "login": "" , ~/~/ Логин
164 + "password": "" , ~/~/ Пароль
165 + "email": "" , ~/~/ Email
166 + "description": "" , ~/~/ Описание
167 + "isEnabled": "" , ~/~/ Признак включения
168 + "parentId": "" , ~/~/ Guid родительского агента
169 + "sessionDuration": "" , ~/~/ Продолжительность сессии, в минутах
170 + "doubleAuth": "" , ~/~/ параметры двухфакторной аутентификации
171 + "kind": "" , ~/~/ тип аутентификации
172 + "target": "" , ~/~/ в случае аутентификации по email - email-адрес
173 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя
174 +
175 +(% style="text-align:left" %)
176 +(% style="color:#000000; font-weight:normal" %) }
177 +
178 +
122 122  (% class="box successmessage" %)
123 123  (((
124 124  (% style="color:#000000; line-height:100%" %)**Получение списка пользователей — **(% lang="en-US" %)**POST /api/v3/users/find**
... ... @@ -132,25 +132,38 @@
132 132  
133 133  (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/users/find>>url:https://hosting.glonasssoft.ru/api/v3/users/find]]
134 134  
135 -(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON): {
192 +(% style="color:#000000" %)Условия фильтрации объектов задаются в теле запроса. Параметры в теле запроса (JSON):
136 136  
137 -(% class="western" %)
138 -{{{ //"parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", // GUID агента, для которого надо получить данные, null - для текущего агента
139 - //"userId": "11111111-c384-43f8-8562-1c3d79a32303", // ID пользователя, по которому фильтруется, null - неважно
140 - "login": "qqqqqq", // Логин пользователя, по которому фильтруется, null - неважно
141 - //"email": "eee" // Email пользователя, по которому фильтруется, null - неважно}}}
194 +(% style="color:#000000" %){
142 142  
143 -(% style="color:#000000" %)}
196 + "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента
197 + "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно
198 + "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно
199 + "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно
144 144  
145 -(% style="color:#000000" %)Ответ: [ { «id»: «», //идентификатор пользователя «lastName»: «», //фамилия «firstName»: «», //имя «position»: «», //должность «phone»: «», //телефон «parentId»: «», //идентификатор клиента-родителя «parentName»: «», //наименование клиента-родителя «organization»: «», //организация «login»: «», //логин «email»: «», //E-mail
201 +(% style="color:#000000" %) }
146 146  
147 -(% class="western" style="margin-bottom:19px" %)
148 -{{{ "sessionDuration":"", // длительность сессии в минутах}}}
203 +(% style="color:#000000" %)Ответ:
149 149  
150 -(% lang="en-US" style="text-align:left" %)
151 -(% style="color:#000000" %) **«status»: 1, //статус пользователя «lastLogged»: «» //дата/время последней авторизации }, … ]**
205 +(% style="color:#000000" %){ (%%)
152 152  
207 + "id": "" , ~/~/ идентификатор пользователя
208 + "lastName": "" , ~/~/ фамилия
209 + "firstName": "" , ~/~/ имя
210 + "position": "" , ~/~/ должность
211 + "phone": "" , ~/~/ телефон
212 + "parentId": "" , ~/~/ идентификатор клиента-родителя
213 + "parentName": "" , ~/~/ наименование клиента-родителя
214 + "organization": "" , ~/~/ организация
215 + "login": "" , ~/~/ логин
216 + "email": "" , ~/~/ E-mail
217 + "sessionDuration":"", ~/~/ длительность сессии в минутах
218 + "status": "1",  ~/~/ статус пользователя
219 + "astLogged": "", ~/~/ дата/время последней авторизации
153 153  
221 +(% style="color:#000000" %) }
222 +
223 +
154 154  (% class="box warningmessage" %)
155 155  (((
156 156  (% style="color:#000000; line-height:100%" %)**Редактирование пользователя — **(% lang="en-US" %)**PUT /api/v3/users**

Меню

ГЛОНАССSoft wiki - 2024 г.