Пользователи дочернего домена (users)

Содержание

Запросы

Запросы

HTTP verb Endpoint Описание

HTTP verb	Endpoint	Описание
`POST`	`/rest/v1/domain/domains/<domain_id>/users`	Создание нового пользователя дочернего домена
`GET`	`/rest/v1/domain/domains/<domain_id>/users`	Получение списка пользователей дочернего домена
`GET`	`/rest/v1/domain/domains/<domain_id>/users/<id>`	Получение данных пользователя дочернего домена
`PATCH`	`/rest/v1/domain/domains/<domain_id>/users/<id>`	Изменение пользователя дочернего домена
`DELETE`	`/rest/v1/domain/domains/<domain_id>/users/<id>`	Удаление пользователя дочернего домена
`LOOKUP`	`/rest/v1/domain/domains/<domain_id>/users`	Поиск идентификатора пользователя дочернего домена

POST

/rest/v1/domain/domains/<domain_id>/users

Создание нового пользователя дочернего домена

GET

/rest/v1/domain/domains/<domain_id>/users

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

GET

/rest/v1/domain/domains/<domain_id>/users/<id>

Получение данных пользователя дочернего домена

PATCH

/rest/v1/domain/domains/<domain_id>/users/<id>

Изменение пользователя дочернего домена

DELETE

/rest/v1/domain/domains/<domain_id>/users/<id>

Удаление пользователя дочернего домена

LOOKUP

/rest/v1/domain/domains/<domain_id>/users

Поиск идентификатора пользователя дочернего домена

Создание нового пользователя дочернего домена

Запрос

Описание полей: user entity

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

POST /rest/v1/domain/domains/521944bd-016c-b839-648f-50e54938780c/users HTTP/1.1
Content-Type: application/json; charset=utf-8

user entity

Ответ

Описание полей: user entity

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "e7adf0aa-05b7-8163-948c-3392a9660db9",
  "name": "Administrator",
  "login": "admin",
  "pwd": "*",
  "timezone": "default",
  "opts": {
    "title": "",
    "comment": "",
    "roles": ["admin"],
    "tags": [],
    "allow_script_crud": false
  },
  "ext": {
    "ct": "2019-08-22T07:27:49.55Z",
    "lwt": "2019-08-22T07:27:49.55Z"
  }
}

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

Запрос

Table 1. Параметры запроса
Имя	Тип	Описание
`filter`	`object`	Фильтр по значениям полей.
`mask`	`str`	Список полей для вывода. Доступные поля для выдачи: id, name, login, timezone, opts.roles, ext.lwt, ext.ct.
`offset`	`int`	Смещение в списке ресурсов, подлежащих выдаче.
`limit`	`int`	Максимальное количество ресурсов в списке.
`order`	`array<object\|str>`	Порядок сортировки ресурсов в списке.
`flat`	`bool`	Преобразование в плоский вид составных полей.

Подробно про формат параметров GET-запроса

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

GET /rest/v1/domain/domains/521944bd-016c-b839-648f-50e54938780c/users?offset=0&limit=2 HTTP/1.1

Ответ

Описание полей: user entity

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "id": "e7adf0aa-05b7-8163-948c-3392a9660db9",
    "name": "Administrator",
    "login": "admin",
    "timezone": "default",
    "opts": {
      "roles": ["admin"]
    },
    "ext": {
      "ct": "2019-08-22T07:27:49.55Z",
      "lwt": "2019-08-22T07:27:49.55Z"
    }
  },
  {
    "id": "d4d867eb-016c-dcae-4508-50e54938780c",
    "name": "xuser1",
    "login": "xuser1",
    "timezone": 3.0,
    "opts": {
      "roles": ["admin","crud","monitor","stat"]
    },
    "ext": {
      "ct": "2019-08-29T09:21:44.20Z",
      "lwt": "2019-08-29T09:21:44.20Z"
    }
  }
]

Получение данных пользователя дочернего домена

Запрос

Table 2. Параметры запроса
Имя	Тип	Описание
`mask`	`str`	Список полей для вывода.
`flat`	`bool`	Преобразование в плоский вид составных полей.

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

GET /rest/v1/domain/domains/521944bd-016c-b839-648f-50e54938780c/users/e7adf0aa-05b7-8163-948c-3392a9660db9 HTTP/1.1

Ответ

Описание полей: user entity

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "e7adf0aa-05b7-8163-948c-3392a9660db9",
  "name": "Administrator",
  "login": "admin",
  "pwd": "*",
  "timezone": "default",
  "opts": {
    "title": "",
    "comment": "",
    "roles": ["admin"],
    "tags": [],
    "allow_script_crud": false
  },
  "ext": {
    "ct": "2019-08-22T07:27:49.55Z",
    "lwt": "2019-08-22T07:27:49.55Z"
  }
}

Изменение пользователя дочернего домена

Поля запрещенные для изменения: id

Запрос

Описание полей: user entity

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

PATCH /rest/v1/domain/domains/521944bd-016c-b839-648f-50e54938780c/users/e7adf0aa-05b7-8163-948c-3392a9660db9 HTTP/1.1
Content-Type: application/json; charset=utf-8

user entity

Ответ

Описание полей: user entity

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "e7adf0aa-05b7-8163-948c-3392a9660db9",
  "name": "Administrator",
  "login": "admin",
  "pwd": "*",
  "timezone": "default",
  "opts": {
    "title": "",
    "comment": "",
    "roles": ["admin"],
    "tags": [],
    "allow_script_crud": false
  },
  "ext": {
    "ct": "2019-08-22T07:27:49.55Z",
    "lwt": "2019-09-10T18:22:44.37Z"
  }
}

Удаление пользователя дочернего домена

Запрос

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

DELETE /rest/v1/domain/domains/521944bd-016c-b839-648f-50e54938780c/users/e7adf0aa-05b7-8163-948c-3392a9660db9 HTTP/1.1

Ответ

Пример ответа

HTTP/1.1 204 No Content

Поиск идентификатора пользователя дочернего домена

Производит поиск ресурса по указанному ключу, возвращает идентификатор(ы) для построения endpoint.

Ключевые поля для поиска: id, login

Запрос

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

LOOKUP /rest/v1/domain/domains/<domain_id>/users HTTP/1.1
Content-Type: application/json; charset=utf-8

"admin"

Ответ

Пример успешного ответа

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

[
  "e7adf0aa-05b7-8163-948c-3392a9660db9"
]

Пример неуспешного ответа

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8

{
  "error_code": 1404,
  "error_message": "Lookup failed"
}