Перейти к основному содержимому

8.7 Пользователь

Свойства объекта Локальный пользователь представлены в таблице 1.

Таблица 1. Свойства объекта Локальный пользователь
namevaluetype
id213integer
nameStepan_Mstring(40)
fullnameСтепан Михайловstring(64)
created1666938150unix time
modified1666938572unix time

Поле name может содержать только буквы латинского алфавита, знаки подчёркивания и минус.

Методы

8.7.1 user-create()

С помощью этого метода создаётся пользователь.

Запрос

{
"jsonrpc": "2.0",
"method": "user-create",
"id": "c273d46a-59ba-11ed-a6e4-d9ebaeb91e77",
"params": {
"name": "Stepan_M",
"fullname": "Степан Михайлов"
}
}

Ответ:

{
"id" : "c273d46a-59ba-11ed-a6e4-d9ebaeb91e77",
"jsonrpc" : "2.0",
"result" : {
"code" : 1,
"data" : {
"id" : 106
}
}
}

8.7.2 user-set-password()

user-set-password() позволяет установить пароль пользователю.

Запрос:

{
"jsonrpc": "2.0",
"method": "user-set-password",
"id": "7f7ff66e-552f-11ed-b872-622aafb91e77",
"params": {
"id": 104,
"password": "VNHfqOpWPk3ZuRVWar"
}
}

Ответ:

{
"id" : "7f7ff66e-552f-11ed-b872-622aafb91e77",
"jsonrpc" : "2.0",
"result" : {
"code" : 1,
"data" : {}
}
}

При отсутствии параметра id происходит смена пароля текущего пользователя.

Запрос:

{
"jsonrpc": "2.0",
"method": "user-set-password",
"id": "46a4a4a6-59b8-11ed-a86d-b06dafb91e77",
"params": {
"password": "MuDY6VIz1IYC4NeqMq"
}
}

Ответ:

{
"id" : "46a4a4a6-59b8-11ed-a86d-b06dafb91e77",
"jsonrpc" : "2.0",
"result" : {
"code" : 1,
"data" : {}
}
}

8.7.3 user-delete()

С помощью метода user-delete() выполняется удаление пользователя.

Запрос:

{
"jsonrpc": "2.0",
"method": "user-delete",
"id": "e8b4bc70-552d-11ed-ad6d-4932b0b91e77",
"params": {
"id": 103
}
}

Ответ:

{
"id" : "e8b4bc70-552d-11ed-ad6d-4932b0b91e77",
"jsonrpc" : "2.0",
"result" : {
"code" : 1,
"data" : {}
}
}

8.7.4 user-list()

user-list() позволяет получить список пользователей.

Запрос:

{
"jsonrpc": "2.0",
"id": "4103b786-568d-11ed-82cb-8e96afb91e77",
"method": "user-list"
}

Ответ:

{
"id" : "4103b786-568d-11ed-82cb-8e96afb91e77",
"jsonrpc" : "2.0",
"result" : {
"code" : 1,
"data" : {
"1" : {
"created" : 1666938150,
"fullname" : null,
"id" : 1,
"modified" : null,
"name" : "MegaSuperAdmin"
},
"105" : {
"created" : 1666938150,
"fullname" : "Степан Михайлов",
"id" : 105,
"modified" : 1666938572,
"name" : "Stepan_M"
},
"2" : {
"created" : 1666938150,
"fullname" : "Mihail Ivanov",
"id" : 2,
"modified" : null,
"name" : "Mihail"
},
"21" : {
"created" : 1666938150,
"fullname" : "Anton Mishin",
"id" : 21,
"modified" : null,
"name" : "anton.mishin"
},
"22" : {
"created" : 1666938150,
"fullname" : "Darya Fedorova",
"id" : 22,
"modified" : null,
"name" : "darya.fedorova"
},
"3" : {
"created" : 1666938150,
"fullname" : null,
"id" : 3,
"modified" : null,
"name" : "NT"
},
"5" : {
"created" : 1666938150,
"fullname" : null,
"id" : 5,
"modified" : null,
"name" : "Watcher"
},
"53" : {
"created" : 1666938150,
"fullname" : "Анна Петрова",
"id" : 53,
"modified" : null,
"name" : "Anna.Petrova"
},
"6" : {
"created" : 1666938150,
"fullname" : "White Super Admin",
"id" : 6,
"modified" : null,
"name" : "white.superadmin"
},
"9" : {
"created" : 1666938150,
"fullname" : null,
"id" : 9,
"modified" : null,
"name" : "Evgueni.Petrov"
}
}
}
}

8.7.5 user-get()

С помощью данного метода можно получить объект Пользователь.

Запрос:

{
"jsonrpc": "2.0",
"id": "5b4f492e-568e-11ed-b51a-59a4afb91e77",
"method": "user-get",
"params": {
"id": 105
}
}

Ответ:

{
"id" : "5b4f492e-568e-11ed-b51a-59a4afb91e77",
"jsonrpc" : "2.0",
"result" : {
"code" : 1,
"data" : {
"created" : 1666938150,
"fullname" : "Степан Михайлов",
"id" : 105,
"modified" : 1666938572,
"name" : "Stepan_M"
}
}
}

8.7.6 role-list()

Этот метод позволяет получить список ролей.

Запрос:

{
"jsonrpc": "2.0",
"id": "e731c118-5438-11ed-b9c0-0889afb91e77",
"method": "role-list"
}

Ответ:

{
"id" : "e731c118-5438-11ed-b9c0-0889afb91e77",
"jsonrpc" : "2.0",
"result" : {
"code" : 1,
"data" : {
"1" : {
"id" : "1",
"name" : "Cluster master"
},
"2" : {
"id" : "2",
"name" : "vDC admin"
},
"3" : {
"id" : "3",
"name" : "vDC user"
},
"4" : {
"id" : "4",
"name" : "vDC viewer"
},
"5" : {
"id" : "5",
"name" : "Resource viewer"
}
}
}
}

8.7.6 role-list()

Этот метод позволяет получить список ролей.

Запрос:

{
"jsonrpc": "2.0",
"id": "e731c118-5438-11ed-b9c0-0889afb91e77",
"method": "role-list"
}

Ответ:

{
"id" : "e731c118-5438-11ed-b9c0-0889afb91e77",
"jsonrpc" : "2.0",
"result" : {
"code" : 1,
"data" : {
"1" : {
"id" : "1",
"name" : "Cluster master"
},
"2" : {
"id" : "2",
"name" : "vDC admin"
},
"3" : {
"id" : "3",
"name" : "vDC user"
},
"4" : {
"id" : "4",
"name" : "vDC viewer"
},
"5" : {
"id" : "5",
"name" : "Resource viewer"
}
}
}
}

8.7.7 user-roles()

user-roles() позволяет получить список ролей, назначенных пользователю.

Запрос:

{
"jsonrpc": "2.0",
"id": "4c48b244-5440-11ed-ac18-ada5afb91e77",
"method": "user-roles",
"params": {
"user_id": 2
}
}

Ответ:

{
"id" : "4c48b244-5440-11ed-ac18-ada5afb91e77",
"jsonrpc" : "2.0",
"result" : {
"code" : 1,
"data" : {
"1000" : 2,
"1001" : 2,
"1003" : 3
}
}
}

Параметр user_id опционален. При его отсутствии предоставяется список пользователя, выполняющего запрос.

Запрос:

{
"jsonrpc": "2.0",
"id": "5915e230-5a7b-11ed-8c79-9770afb91e77",
"method": "user-roles"
}

Ответ:

{
"id" : "5915e230-5a7b-11ed-8c79-9770afb91e77",
"jsonrpc" : "2.0",
"result" : {
"code" : 1,
"data" : {
"1000" : 2,
"1001" : 2,
"1003" : 3,
"1009" : 4,
"1011" : 3,
"1014" : 2
}
}
}

8.7.8 vdc-roles()

С помощью метода vdc-roles() можно получить список пользователей, имеющих назначенные роли в указанном ВЦОД.

Запрос:

{
"jsonrpc": "2.0",
"id": "fd3ae066-640f-11ed-a7d1-ed06b0b91e77",
"method": "vdc-roles",
"params": {
"id": 1009
}
}

Ответ:

{
"id" : "fd3ae066-640f-11ed-a7d1-ed06b0b91e77",
"jsonrpc" : "2.0",
"result" : {
"code" : 1,
"data" : {
"2" : [ 4, 3 ],
"21": [ 2, 3, 4 ],
"9" : [ 2 ]
}
}
}

8.7.9 user-role-assign()

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

Запрос:

{
"jsonrpc": "2.0",
"method": "user-role-assign",
"id": "a784c414-5502-11ed-b140-e8e1afb91e77",
"params": {
"user_id": 2,
"role_id": 2,
"vdc_id": 1014
}
}

Ответ:

{
"id" : "a784c414-5502-11ed-b140-e8e1afb91e77",
"jsonrpc" : "2.0",
"result" : {
"code" : 1,
"data" : {}
}
}

8.7.10 user-role-daassign()

С помощью данного метода можно отозвать роли у пользователя в указанном ВЦОД.

Запрос:

{
"jsonrpc": "2.0",
"method": "user-role-deassign",
"id": "167c5a30-5503-11ed-9c0f-abf9afb91e77",
"params": {
"user_id": 2,
"role_id": 2,
"vdc_id": 1014
}
}

Ответ:

{
"id" : "167c5a30-5503-11ed-9c0f-abf9afb91e77",
"jsonrpc" : "2.0",
"result" : {
"code" : 1
"data" : {}
}
}

8.7.11 user-remote-add

Метод позволяет определить сеть, которая обеспечит пользователю возможность удалённого доступа к кластеру.

Запрос:

{
"jsonrpc": "2.0",
"method": "user-remote-add",
"id": "12cdd1e7-27fe-455f-9d1c-a5d8a4d50073",
"params": {
"user_id": 4109,
"remote": "10.0.0.0/24"
}
}

Ответ:

{
"id" : "12cdd1e7-27fe-455f-9d1c-a5d8a4d50073",
"jsonrpc" : "2.0",
"result" : {
"code" : 1,
"data" : {}
}
}

8.7.12 user-remote-list

Метод получения списка сетей удалённого доступа пользователя к кластеру.

Запрос:

{
"jsonrpc": "2.0",
"method": "user-remote-list",
"id": "c7679886-04a8-456c-9e06-97ae6e0141ca",
"params": {
"user_id": "4109"
}
}

Ответ:

{
"id" : "c7679886-04a8-456c-9e06-97ae6e0141ca",
"jsonrpc" : "2.0",
"result" : {
"code" : 1,
"data" : [
"10.0.0.0/24"
]
}
}

8.7.13 user-remote-delete

Метод исключения сети, через которую пользователь имел возможность удалённого подключения к кластеру.

Запрос:

{
"jsonrpc": "2.0",
"method": "user-remote-delete",
"id": "315d72a5-d652-44b4-93b9-cc05096b75c8",
"params": {
"user_id": 4109,
"remote": "10.0.0.0/24"
}
}

Ответ:

{
"id" : "315d72a5-d652-44b4-93b9-cc05096b75c8",
"jsonrpc" : "2.0",
"result" : {
"code" : 1,
"data" : {}
}
}

8.7.14 user-vhost-add

Метод добавления виртуального хоста пользователю.

Запрос:

{
"jsonrpc": "2.0",
"method": "user-vhost-add",
"id": "87d55ca1-1894-441a-9e37-487f85c775e4",
"params": {
"user_id": 4109,
"vhost": "ofjvde.com"
}
}

Ответ:

{
"id" : "87d55ca1-1894-441a-9e37-487f85c775e4",
"jsonrpc" : "2.0",
"result" : {
"code" : 1,
"data" : {}
}
}

8.7.15 user-vhost-list

Метод получения списка виртуальных хостов пользователя.

Запрос:

{
"jsonrpc": "2.0",
"method": "user-vhost-list",
"id": "68e85999-3312-41de-a245-aeb07294e204",
"params": {
"user_id": "4109"
}
}

Ответ:

{
"id" : "68e85999-3312-41de-a245-aeb07294e204",
"jsonrpc" : "2.0",
"result" : {
"code" : 1,
"data" : [
"ofjvde.com"
]
}
}

8.7.16 user-vhost-delete

Метод удаления виртуального хоста для пользователя.

Запрос:

{
"jsonrpc": "2.0",
"method": "user-vhost-delete",
"id": "61f86ae3-e926-4d68-9d18-1473db35aacb",
"params": {
"user_id": 4109,
"vhost": "ofjvde.com"
}
}

Ответ:

{
"id" : "61f86ae3-e926-4d68-9d18-1473db35aacb",
"jsonrpc" : "2.0",
"result" : {
"code" : 1,
"data" : {}
}
}