.. meta::
  :description: Teambox документация


=======
Teambox
=======

Список пользователей
====================

::

    GET /domains/{domain_id}/teambox/users/


Ответ
-----

.. code-block:: javascript

    HTTP 200 OK

    [
      {
        "blocked": false,
        "email": "user1@some.ru",
        "quota": 5368709120,
      },
      {
        "blocked": false,
        "email": "user2@some.ru",
        "quota": 5368709120
      }
    ]


Описание полей
--------------

+---------------------------------+---------+-----------------------+
| Название                        | Тип     | Описание              |
+=================================+=========+=======================+
| blocked                         | Boolean | Статус блокировки     |
+---------------------------------+---------+-----------------------+
| email                           | String  | Адрес пользователя    |
+---------------------------------+---------+-----------------------+
| quota                           | Integer | Размер квоты в байтах |
+---------------------------------+---------+-----------------------+


Добавление пользователя
=======================

::

    POST /domains/{domain_id}/teambox/users/


Поля
----

quota: required: integer
    Размер доступного для пользователя места (кратно 1024)

.. code-block:: javascript

    {
      "email": "user3@some.ru",
      "quota": 3221225472
    }


Ответ
-----

.. code-block:: javascript

    HTTP 201 CREATED

    {
      "blocked": true,
      "email": "user3@some.ru",
      "quota": 3221225472
    }



Получение пользователя
======================

::

    GET /domains/{domain_id}/teambox/users/{user_id}/


Ответ
-----

.. code-block:: javascript

    HTTP 200 OK

    {
      "blocked": false,
      "email": "user1@some.ru",
      "quota": 5368709120,
    }


Обновление данных пользователя
==============================

::

    PATCH /domains/{domain_id}/teambox/users/{user_id}/

Поля
----

blocked: optional: boolean
    Статус блокировки
quota: optional: integer
    Размер доступного для пользователя места (кратно 1024)

Можно обновить оба или одно из полей

.. code-block:: javascript

    {
      "blocked": true,
      "quota": 3221225472
    }


Ответ
-----

.. code-block:: javascript

    HTTP 200 OK

    {
      "blocked": true,
      "email": "user1@some.ru",
      "quota": 3221225472
    }



Удаление пользователя
=====================

::

    DELETE /domains/{domain_id}/teambox/users/{user_id}/


Ответ
-----

.. code-block:: javascript

    HTTP 204 NO CONTENT