GNUnet Identity API Service
===========================

Variables in single quotes ``'...'`` can or must be changed according to your specific case.

``public_key`` is the public key of an identity.

``name`` is the name of an identity. ``newname`` is the new name of an identity.

``subsystem`` is a subsystem of GNUnet.


GET Requests
------------

+--------------------+---------------------------------------------------------------+
|**Title**           |Returns all identities with name and public key                |
+--------------------+---------------------------------------------------------------+
|**URL**             |:literal:`/identity/all`                                       |
+--------------------+---------------------------------------------------------------+
|**Method**          |**GET**                                                        |
+--------------------+---------------------------------------------------------------+
|**URL Params**      |none                                                           |
+--------------------+---------------------------------------------------------------+
|**Data Params**     |none                                                           |
+--------------------+---------------------------------------------------------------+
|**Success Response**|[{"pubkey":"*public_key*", "name":"*name*"},...]               |
+--------------------+---------------------------------------------------------------+
|**Error Response**  |{"error":"*error_desc*"}                                       |
+--------------------+---------------------------------------------------------------+
|**Attention**       | The response in this request is an array!                     |
+--------------------+---------------------------------------------------------------+

|

+--------------------+----------------------------------------------------------------+
|**Title**           |Returns only a specific identity                                |
+--------------------+----------------------------------------------------------------+
|**URL**             | ``/identity/pubkey/'public_key'`` or ``/identity/name/'name'`` |
+--------------------+----------------------------------------------------------------+
|**Method**          |**GET**                                                         |
+--------------------+----------------------------------------------------------------+
|**URL Params**      |none                                                            |
+--------------------+----------------------------------------------------------------+
|**Data Params**     |none                                                            |
+--------------------+----------------------------------------------------------------+
|**Success Response**|{"pubkey":"*public_key*", "name":"*name*"}                      |
+--------------------+----------------------------------------------------------------+
|**Error Response**  |{"error":"*error_desc*"}                                        |
+--------------------+----------------------------------------------------------------+

|

+--------------------+---------------------------------------------------------------+
|**Title**           |Returns default identity for specific subsystem                |
+--------------------+---------------------------------------------------------------+
|**URL**             |:literal:`/identity/subsystem/'subsystem'`                     |
+--------------------+---------------------------------------------------------------+
|**Method**          |**GET**                                                        |
+--------------------+---------------------------------------------------------------+
|**URL Params**      |none                                                           |
+--------------------+---------------------------------------------------------------+
|**Data Params**     |none                                                           |
+--------------------+---------------------------------------------------------------+
|**Success Response**|{"pubkey":"*public_key*", "name":"*name*"}                     |
+--------------------+---------------------------------------------------------------+
|**Error Response**  |{"error":"*error_desc*"}                                       |
+--------------------+---------------------------------------------------------------+


POST Request
------------

+--------------------+----------------------------------------------------+
|**Title**           |Creates an identity                                 |
+--------------------+----------------------------------------------------+
|**URL**             |:literal:`/identity`                                |
+--------------------+----------------------------------------------------+
|**Method**          |**POST**                                            |
+--------------------+----------------------------------------------------+
|**URL Params**      |none                                                |
+--------------------+----------------------------------------------------+
|**Data Params**     | {"name":'*name*'}                                  |
+--------------------+----------------------------------------------------+
|**Success Response**|Response Code: :literal:`201` (Created)             |
+--------------------+----------------------------------------------------+
|**Error Response**  | | {"error":"*error_desc*"}                         |
|                    | | *or*                                             |
|                    | | Response Code: :literal:`409` (Conflict)         |
+--------------------+----------------------------------------------------+

PUT Request
-----------

+--------------------+----------------------------------------------------------------+
|**Title**           |Changes name of identity                                        |
+--------------------+----------------------------------------------------------------+
|**URL**             | ``/identity/pubkey/'public_key'`` or ``/identity/name/'name'`` |
+--------------------+----------------------------------------------------------------+
|**Method**          |**PUT**                                                         |
+--------------------+----------------------------------------------------------------+
|**URL Params**      |none                                                            |
+--------------------+----------------------------------------------------------------+
|**Data Params**     | {"newname":'*newname*'}                                        |
+--------------------+----------------------------------------------------------------+
|**Success Response**|Response Code: :literal:`204` (No Content)                      |
+--------------------+----------------------------------------------------------------+
|**Error Response**  | | {"error":"*error_desc*"}                                     |
|                    | | *or*                                                         |
|                    | | Response Code: :literal:`404` (Not Found)                    |
|                    | | *or*                                                         |
|                    | | Response Code: :literal:`409` (Conflict)                     |
+--------------------+----------------------------------------------------------------+

|

+--------------------+----------------------------------------------------------------+
|**Title**           |Sets identity as default for a subsystem                        |
+--------------------+----------------------------------------------------------------+
|**URL**             | ``/identity/pubkey/'public_key'`` or ``/identity/name/'name'`` |
+--------------------+----------------------------------------------------------------+
|**Method**          |**PUT**                                                         |
+--------------------+----------------------------------------------------------------+
|**URL Params**      |none                                                            |
+--------------------+----------------------------------------------------------------+
|**Data Params**     | {"subsystem":'*subsystem*'}                                    |
+--------------------+----------------------------------------------------------------+
|**Success Response**|Response Code: :literal:`204` (No Content)                      |
+--------------------+----------------------------------------------------------------+
|**Error Response**  | | {"error":"*error_desc*"}                                     |
|                    | | *or*                                                         |
|                    | | Response Code: :literal:`404` (Not Found)                    |
|                    | | *or*                                                         |
|                    | | Response Code: :literal:`409` (Conflict)                     |
+--------------------+----------------------------------------------------------------+

DELETE Request
--------------

+--------------------+----------------------------------------------------------------+
|**Title**           |Deletes specific identity                                       |
+--------------------+----------------------------------------------------------------+
|**URL**             | ``/identity/pubkey/'public_key'`` or ``/identity/name/'name'`` |
+--------------------+----------------------------------------------------------------+
|**Method**          |**DELETE**                                                      |
+--------------------+----------------------------------------------------------------+
|**URL Params**      |none                                                            |
+--------------------+----------------------------------------------------------------+
|**Data Params**     |none                                                            |
+--------------------+----------------------------------------------------------------+
|**Success Response**|Response Code: :literal:`204` (No Content)                      |
+--------------------+----------------------------------------------------------------+
|**Error Response**  | | {"error":"*error_desc*"}                                     |
|                    | | *or*                                                         |
|                    | | Response Code: :literal:`404` (Not Found)                    |
+--------------------+----------------------------------------------------------------+

OPTIONS Request
---------------

+--------------------+---------------------------------------------------------+
|**Title**           |Gets request options                                     |
+--------------------+---------------------------------------------------------+
|**URL**             |:literal:`/identity`                                     |
+--------------------+---------------------------------------------------------+
|**Method**          |**OPTIONS**                                              |
+--------------------+---------------------------------------------------------+
|**URL Params**      |none                                                     |
+--------------------+---------------------------------------------------------+
|**Data Params**     |none                                                     |
+--------------------+---------------------------------------------------------+
|**Success Response**|                                                         |
+--------------------+---------------------------------------------------------+
|**Error Response**  |none                                                     |
+--------------------+---------------------------------------------------------+