blob: 79120c37fc3dbfd7402f826c918c9a88c8764ccd (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
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` |
+--------------------+---------------------------------------------------------------+
|**Method** |**GET** |
+--------------------+---------------------------------------------------------------+
|**URL Params** |none |
+--------------------+---------------------------------------------------------------+
|**Data Params** |none |
+--------------------+---------------------------------------------------------------+
|**Success Response**|[{"pubkey":"*public_key*", "name":"*name*"},...] |
+--------------------+---------------------------------------------------------------+
|**Error Response** |{"error":"*error_desc*"} |
+--------------------+---------------------------------------------------------------+
|
+--------------------+----------------------------------------------------+
|**Title** |Returns only a specific identity |
+--------------------+----------------------------------------------------+
|**URL** |:literal:`/identity?pubkey='public_key'` |
+--------------------+----------------------------------------------------+
|**Method** |**GET** |
+--------------------+----------------------------------------------------+
|**URL Params** |none |
+--------------------+----------------------------------------------------+
|**Data Params** |none |
+--------------------+----------------------------------------------------+
|**Success Response**|[{"pubkey":"*public_key*", "name":"*name*"}] |
+--------------------+----------------------------------------------------+
|**Error Response** |{"error":"*error_desc*"} |
+--------------------+----------------------------------------------------+
|
+--------------------+----------------------------------------------------+
|**Title** |Returns only a specific identity |
+--------------------+----------------------------------------------------+
|**URL** |:literal:`/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*"} |
+--------------------+---------------------------------------------------------------+
|**Attention** |The response in this request is NOT an array! |
+--------------------+---------------------------------------------------------------+
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** |:literal:`/identity` |
+--------------------+----------------------------------------------------+
|**Method** |**PUT** |
+--------------------+----------------------------------------------------+
|**URL Params** |none |
+--------------------+----------------------------------------------------+
|**Data Params** | {"newname":'*newname*', "pubkey": '*public_key*'} |
+--------------------+----------------------------------------------------+
|**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** |Changes name of identity |
+--------------------+----------------------------------------------------+
|**URL** |:literal:`/identity` |
+--------------------+----------------------------------------------------+
|**Method** |**PUT** |
+--------------------+----------------------------------------------------+
|**URL Params** |none |
+--------------------+----------------------------------------------------+
|**Data Params** | {"newname":'*newname*', "name": '*name*'} |
+--------------------+----------------------------------------------------+
|**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** |:literal:`/identity` |
+--------------------+------------------------------------------------------+
|**Method** |**PUT** |
+--------------------+------------------------------------------------------+
|**URL Params** |none |
+--------------------+------------------------------------------------------+
|**Data Params** | {"subsystem":'*subsystem*', "pubkey": '*public_key*'}|
+--------------------+------------------------------------------------------+
|**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** |:literal:`/identity` |
+--------------------+----------------------------------------------------+
|**Method** |**PUT** |
+--------------------+----------------------------------------------------+
|**URL Params** |none |
+--------------------+----------------------------------------------------+
|**Data Params** | {"subsystem":'*subsystem*', "name": '*name*'} |
+--------------------+----------------------------------------------------+
|**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** |:literal:`/identity?pubkey='public_key'` |
+--------------------+----------------------------------------------------+
|**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) |
+--------------------+----------------------------------------------------+
|
+--------------------+----------------------------------------------------+
|**Title** |Deletes specific identity |
+--------------------+----------------------------------------------------+
|**URL** |:literal:`/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 |
+--------------------+---------------------------------------------------------+
|
