Account API v1
========================

This page contains all endpoints for the Account API v1.


Every call requires your API Key to be sent via the ``X-Reseller-Api-Key`` header. A ``401 UNAUTHORIZED``
status code will be sent back if credentials are missing. All the requests needs to have the port 9534.


.. autoflask:: portal.app:get_app()
   :undoc-static:
   :blueprints: reseller_api_account_v1


Ormuco objects types and descriptions
-------------------------------------

A description of the different type of objects used in the Ormuco platform and returned by the API.

**Client**

+-----------------------+---------+--------------------------------------------------------+
| Attribute             | Type    | Description                                            |
+-----------------------+---------+--------------------------------------------------------+
| activated             | boolean | | Whether this client is activated or not. An          |
|                       |         | | activated client can use Portal and communicate      |
|                       |         | | with Openstack.                                      |
+-----------------------+---------+--------------------------------------------------------+
| billing_status        | string  | | A status describing the current situation of a       |
|                       |         | | client relative to his billing.                      |
+-----------------------+---------+--------------------------------------------------------+
| date_created          | string  | The date of creation of the client.                    |
+-----------------------+---------+--------------------------------------------------------+
| date_deleted          | string  | | The date of deletion of this client, if the client   |
|                       |         | | has been deleted.                                    |
+-----------------------+---------+--------------------------------------------------------+
| date_first_activation | string  | The date of the first activation of the client.        |
+-----------------------+---------+--------------------------------------------------------+
| default_project_id    | string  | The project id of the default project of the client.   |
+-----------------------+---------+--------------------------------------------------------+
| deleted               | boolean | Whether the client has been deleted.                   |
+-----------------------+---------+--------------------------------------------------------+
| email                 | string  | The e-mail address of the client.                      |
+-----------------------+---------+--------------------------------------------------------+
| id                    | string  | Main identifier of the client.                         |
+-----------------------+---------+--------------------------------------------------------+
| projects              | array   | | A list of the project ids accessible to the client.  |
|                       |         | | Include projects shared through user collaboration.  |
+-----------------------+---------+--------------------------------------------------------+
| reseller_id           | string  | The id of the reseller owning the client.              |
+-----------------------+---------+--------------------------------------------------------+
| signup_ip_address     | string  | The IP address used by the client when he signed up.   |
+-----------------------+---------+--------------------------------------------------------+
| validated             | boolean | Whether the client has validated his e-mail.           |
+-----------------------+---------+--------------------------------------------------------+
| client_information    | object  | | An object containing private information relative    |
|                       |         | | to the client.                                       |
+-----------------------+---------+--------------------------------------------------------+
| └ first_name          | string  | The first name of the client.                          |
+-----------------------+---------+--------------------------------------------------------+
| └ last_name           | string  | The last name of the client.                           |
+-----------------------+---------+--------------------------------------------------------+
| └ company             | string  | The name of the company the client belongs to.         |
+-----------------------+---------+--------------------------------------------------------+
| └ address_1           | string  | The first line of the address of the client.           |
+-----------------------+---------+--------------------------------------------------------+
| └ address_2           | string  | The second line of the address of the client.          |
+-----------------------+---------+--------------------------------------------------------+
| └ city                | string  | The name of the city of the client.                    |
+-----------------------+---------+--------------------------------------------------------+
| └ state               | string  | The name of the country state of the client.           |
+-----------------------+---------+--------------------------------------------------------+
| └ country             | string  | The name of the country of the client.                 |
+-----------------------+---------+--------------------------------------------------------+
| └ zip_code            | string  | The zip code of the client.                            |
+-----------------------+---------+--------------------------------------------------------+
| └ phone               | string  | The phone number of the client.                        |
+-----------------------+---------+--------------------------------------------------------+
| └ phone_extension     | string  | The phone extension of the client.                     |
+-----------------------+---------+--------------------------------------------------------+
| └ language            | string  | The language of the client (abbreviated to 2 letters). |
+-----------------------+---------+--------------------------------------------------------+