-
Notifications
You must be signed in to change notification settings - Fork 2
/
apiary.apib
805 lines (521 loc) · 34.4 KB
/
apiary.apib
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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
FORMAT: 1A
# Bouncer API
The API for the bouncer firewall appliance, automating blacklisting via `ufw`. See https://github.com/nmfta-repo/nmfta-bouncer for the server code.
The version documented here is API version `1.1`. All endpoints below have a `/v1.1/` leading path element.
## Authentication
This API uses Custom HTTP Header Bearer-token authentication. The following headers are required to be sent with each request
```http
Authorization: Bearer {access token from /login}
```
## Working with Date and Time
Dates and times in the API are treated as opaque data types at present. Any date-time format can be used as long as the code consuming it is consistent with the code populating it.
We recommend all times in UTC, formatted using ISO 8601 string (format `yyyy-MM-ddTHH:mm:ss.fffZ`).
## Error Codes
Errors in this API are returned in JSON objects with error code references in an `Error` field. If an endpoint returns a status code other than `200` then it will return a JSON error object indicating the error in `Error` field. No descriptions of the error will be provided, client code or developers need to consult the table here to understand the value in the `Error` field.
| Endpoint | Error Code | Description |
|:-------------------------------------------|:----------:|:--------------------------------------------------------------------------------------|
| `/register` | 1001 | User Name is required |
| | 1002 | Password is required |
| | 1003 | Duplicate User Name / User already exists |
| | 1004 | User name too long |
| | 1005 | Invalid Password |
| `/login` | 2000 | Missing User Name |
| | 2001 | Missing Password |
| | 2002 | Missing Grant type |
| | 2003 | Invalid User or password is not valid |
| `/whitelists/IPAddresses/create` | 3000 | IPv4 or IPv6 is required |
| | 3001 | IP Address is invalid |
| | 3002 | Start Date is required |
| | 3003 | Start Date is invalid |
| | 3004 | End Date is required |
| | 3005 | End Date is invalid |
| | 3006 | End Date needs to be greater than Start Date |
| | 3007 | Comments too long (restrict to 3000 characters or less) |
| | 3008 | IP Address already whitelisted |
| | 3009 | IP Address currently blacklisted, remove it from blacklist before adding to whitelist |
| `/blacklists/IPAddresses/create` | 4000 | IPv4 or IPv6 is required |
| | 4001 | IP Address is invalid |
| | 4002 | Start Date is required |
| | 4003 | Start Date is invalid |
| | 4004 | End Date is required |
| | 4005 | End Date is invalid |
| | 4006 | End Date needs to be greater than Start Date |
| | 4007 | Comments too long (restrict to 3000 characters or less) |
| | 4008 | IP Address already blacklisted |
| | 4009 | IP Address currently whitelisted, remove it from whitelist before adding to blacklist |
|`/whitelists/ipaddresses/{entry_ id}/delete`| 5000 | Entry Id is required and should be an integer |
| | 5001 | Entry Id not found |
| `/blacklists/ipaddresses/{entry_id}/delete`| 6000 | Entry Id is required and should be an integer |
| | 6001 | Entry Id not found |
# Group Whitelist
## All Contents [GET /v1.1/whitelists]
This will list the entire contents of the Whitelist including both IP Addresses and Geo Locations.
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ IPAddresses (array[IP Address Array Pair], required, fixed-type) - matching IP Address Objects found
+ GeoLocations: `884d9804999fc47a3c2694e49ad2536a#CA` (array[string], required, fixed-type) - matching Geo Location Objects (in short string form `{id}#{cc}`) found
+ Response 400 (application/json)
API Error
+ Attributes (Return)
# Group Whitelist: IP Addresses
## Search [GET /v1.1/whitelists/ipaddresses/filter/{search_filter}]
Search for IP Addresses in the Whitelist
+ Parameters
+ search_filter: `192.168.100.0+24,192.168.101.0+24` (string, required) - an comma-separated lsit of IP addresses in CIDR format (`192.168.100.14/24`) except with `/` replaced by `+`
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ SearchResult (object)
+ Input_IP: `192.168.100.0/24,192.168.101.0/24` (string, required) - the input search string, with the proper '/' in CIDR, not '+' as needed in the endpoint URL
+ Entries (array[IP Address Entry Pair], required, fixed-type) - matching IP Address and Object Entry IDs
+ Response 400 (application/json)
API Error
+ Attributes (Return)
## List [GET /v1.1/whitelists/ipaddresses]
List all IP Addresses in the Whitelist
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ IPAddresses (array[IP Address Array Pair], required, fixed-type) - matching IP Address Objects found
+ Response 400 (application/json)
API Error
+ Attributes (Return)
## Get Details [GET /v1.1/whitelists/ipaddresses/{entry_id}]
Get Details of an IP Address Entry in the Whitelist
+ Parameters
+ entry_id: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the IP Address; opaque but likely a GUID
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ Entry (IP Address)
+ Response 400 (application/json)
API Error
+ Attributes (Return)
## Create [POST /v1.1/whitelists/ipaddresses/create]
Create an IP Address in the Whitelist
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Attributes (IP Address)
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ EntryID: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the newly created IP Address; opaque but likely a GUID
+ Response 400 (application/json)
API Error
+ Attributes (Return)
## Update [PUT /v1.1/whitelists/ipaddresses/{entry_id}/update]
Update an IP Address in the Whitelist
+ Parameters
+ entry_id: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the IP Address; opaque but likely a GUID
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Attributes (IP Address)
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ EntryID: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the newly updated IP Address; opaque but likely a GUID
+ Response 400 (application/json)
API Error
+ Attributes (Return)
## Remove [DELETE /v1.1/whitelists/ipaddresses/{entry_id}/delete]
Remove an IP Address in the Whitelist
+ Parameters
+ entry_id: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the IP Address; opaque but likely a GUID
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Attributes (IP Address)
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ EntryID: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the deleted IP Address ; opaque but likely a GUID
+ Response 400 (application/json)
API Error
+ Attributes (Return)
# Group Whitelist: Geo Locations
## List [GET /v1.1/whitelists/geolocations]
List all Geo Locations in the Whitelist
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ GeoLocations: `884d9804999fc47a3c2694e49ad2536a#CA` (array[string], required, fixed-type) - matching Geo Location Objects (in short string form `{id}#{cc}`) found
+ Response 400 (application/json)
API Error
+ Attributes (Return)
## Get Details [GET /v1.1/whitelists/geolocations/{entry_id}]
Get Details of a Geo Location Entry in the Whitelist
+ Parameters
+ entry_id: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the Geo Location; opaque but likely a GUID
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ Entry (Geo Location)
+ Response 400 (application/json)
API Error
+ Attributes (Return)
## Create [POST /v1.1/whitelists/geolocations/create]
Create a Geo Location in the Whitelist. When POSTed-to this endpoint, Bouncer scans `geolist.txt` for any IPs matching the Country Code (CC) in the POSTed object and, for each: Bouncer will create a new ipaddress in this list (black- or white-list).
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Attributes (Geo Location)
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ EntryID: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the newly created Geo Location; opaque but likely a GUID
+ Response 400 (application/json)
API Error
+ Attributes (Return)
## Update [PUT /v1.1/whitelists/geolocations/{entry_id}/update]
Update a Geo Location in the Whitelist
+ Parameters
+ entry_id: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the Geo Location; opaque but likely a GUID
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Attributes (Geo Location)
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ EntryID: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the newly updated Geo Location; opaque but likely a GUID
+ Response 400 (application/json)
API Error
+ Attributes (Return)
## Remove [DELETE /v1.1/whitelists/geolocations/{entry_id}/delete]
Remove a Geo Location in the Whitelist
+ Parameters
+ entry_id: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the Geo Location; opaque but likely a GUID
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Attributes (Geo Location)
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ EntryID: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the deleted Geo Location ; opaque but likely a GUID
+ Response 400 (application/json)
API Error
+ Attributes (Return)
# Group Blacklist
## All Contents [GET /v1.1/blacklists]
This will list the entire contents of the Whitelist including both IP Addresses and Geo Locations.
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ IPAddresses (array[IP Address Array Pair], required, fixed-type) - matching IP Address Objects found
+ GeoLocations: `884d9804999fc47a3c2694e49ad2536a#CA` (array[string], required, fixed-type) - matching Geo Location Objects (in short string form `{id}#{cc}`) found
+ Response 400 (application/json)
API Error
+ Attributes (Return)
# Group Blacklist: IP Addresses
## Search [GET /v1.1/blacklists/ipaddresses/filter/{search_filter}]
Search for IP Addresses in the Blacklist
+ Parameters
+ search_filter: `192.168.100.0+24,192.168.101.0+24` (string, required) - an comma-separated lsit of IP addresses in CIDR format (`192.168.100.14/24`) except with `/` replaced by `+`
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ SearchResult (object)
+ Input_IP: `192.168.100.0/24,192.168.101.0/24` (string, required) - the input search string, with the proper '/' in CIDR, not '+' as needed in the endpoint URL
+ Entries (array[IP Address Entry Pair], required, fixed-type) - matching IP Address and Object Entry IDs
+ Response 400 (application/json)
API Error
+ Attributes (Return)
## List [GET /v1.1/blacklists/ipaddresses]
List all IP Addresses in the Blacklist
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ IPAddresses (array[IP Address Array Pair], required, fixed-type) - matching IP Address Objects found
+ Response 400 (application/json)
API Error
+ Attributes (Return)
## Get Details [GET /v1.1/blacklists/ipaddresses/{entry_id}]
Get Details of an IP Address Entry in the Blacklist
+ Parameters
+ entry_id: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the IP Address; opaque but likely a GUID
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ Entry (IP Address)
+ Response 400 (application/json)
API Error
+ Attributes (Return)
## Create [POST /v1.1/blacklists/ipaddresses/create]
Create an IP Address in the Blacklist
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Attributes (IP Address)
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ EntryID: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the newly created IP Address; opaque but likely a GUID
+ Response 400 (application/json)
API Error
+ Attributes (Return)
## Update [PUT /v1.1/blacklists/ipaddresses/{entry_id}/update]
Update an IP Address in the Blacklist
+ Parameters
+ entry_id: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the IP Address; opaque but likely a GUID
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Attributes (IP Address)
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ EntryID: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the newly updated IP Address; opaque but likely a GUID
+ Response 400 (application/json)
API Error
+ Attributes (Return)
## Remove [DELETE /v1.1/blacklists/ipaddresses/{entry_id}/delete]
Remove an IP Address in the Blacklist
+ Parameters
+ entry_id: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the IP Address; opaque but likely a GUID
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Attributes (IP Address)
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ EntryID: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the deleted IP Address ; opaque but likely a GUID
+ Response 400 (application/json)
API Error
+ Attributes (Return)
# Group Blacklist: Geo Locations
## List [GET /v1.1/blacklists/geolocations]
List all Geo Locations in the Blacklist
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ GeoLocations: `884d9804999fc47a3c2694e49ad2536a#CA` (array[string], required, fixed-type) - matching Geo Location Objects (in short string form `{id}#{cc}`) found
+ Response 400 (application/json)
API Error
+ Attributes (Return)
## Get Details [GET /v1.1/blacklists/geolocations/{entry_id}]
Get Details of a Geo Location Entry in the Blacklist
+ Parameters
+ entry_id: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the Geo Location; opaque but likely a GUID
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ Entry (Geo Location)
+ Response 400 (application/json)
API Error
+ Attributes (Return)
## Create [POST /v1.1/blacklists/geolocations/create]
Create a Geo Location in the Blacklist. When POSTed-to this endpoint, Bouncer scans `geolist.txt` for any IPs matching the Country Code (CC) in the POSTed object and, for each: Bouncer will create a new ipaddress in this list (black- or white-list).
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Attributes (Geo Location)
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ EntryID: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the newly created Geo Location; opaque but likely a GUID
+ Response 400 (application/json)
API Error
+ Attributes (Return)
## Update [PUT /v1.1/blacklists/geolocations/{entry_id}/update]
Update a Geo Location in the Blacklist
+ Parameters
+ entry_id: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the Geo Location; opaque but likely a GUID
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Attributes (Geo Location)
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ EntryID: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the newly updated Geo Location; opaque but likely a GUID
+ Response 400 (application/json)
API Error
+ Attributes (Return)
## Remove [DELETE /v1.1/blacklists/geolocations/{entry_id}/delete]
Remove a Geo Location in the Blacklist
+ Parameters
+ entry_id: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the Geo Location; opaque but likely a GUID
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Attributes (Geo Location)
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ EntryID: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the deleted Geo Location ; opaque but likely a GUID
+ Response 400 (application/json)
API Error
+ Attributes (Return)
# Group Check IP Addresses
## Test for List Membership [GET /v1.1/check/{ip_address}]
Check if an IP Address is Already White- or Black-Listed
+ Parameters
+ ip_address: `192.168.100.14` (string, required) - the IP address to check
+ Request
+ Headers
Authorization: Bearer {access token from /login}
+ Response 200 (application/json)
+ Attributes (object)
+ Result (object, required)
+ List (enum[string], required)
+ Sample: `Whitelist`
+ Members
+ `Whitelist`
+ `Blacklist`
+ Status: `Success` (string, required, fixed)
+ Message (string) - an optional message
+ Entry (IP Address, required) - matching IP Address Object found
+ Response 400 (application/json)
API Error
+ Attributes (Return)
# Group Users Login & Registration
## Login to Bouncer API [POST /v1.1/login]
Authenticate to this Bouncer instance.
+ Request
+ Attributes
+ username (string, required)
+ password (string, required)
+ grant_type (string, required) - must be `password`
+ Response 200 (application/json)
+ Attributes (object)
+ access_token (string, required) - the access token to use in all future requests
+ token_type: `bearer` (string, required, fixed) - always `bearer`
+ expires_in (string, required) - the expiry of this bearer token in seconds
+ claim_level: `complete` (string, required, fixed) - always `complete`
+ Response 400 (application/json)
API Error
+ Attributes (Return)
## Register New User [POST /v1.1/register]
ONLY AVAILABLE when Bouncer is started with the `--testing` parameter.
Register a new user with this instance of Bouncer.
+ Request
+ Attributes (object)
+ username: `user1` (string, required) - new username
+ password: `not123456` (string, required) - new user's password
+ Response 200 (application/json)
+ Attributes (object)
+ message: `all good with user creation` (string, required)
+ Response 400 (application/json)
API Error
+ Attributes (Return)
# Data Structures
## Return (object)
The error return type
### Properties
+ Status: `Invalid` (string, required) - The status of the return
+ Error: `1001` (string, required) - the error value
## IP Address (object)
The IP address information referenced by Bouncer when building `ufw` rules
### Properties
+ IPv4: `192.168.100.14/24` (string) - IP Address v4 in CIDR Format. Either IPv4 or IPv6 MUST be present.
+ IPv6: `2001:db8::/64` (string) - IP Address v6 in CIDR Format. Either IPv4 or IPv6 MUST be present.
+ Start_Date: `2019-04-05T02:04:16Z` (required, string) - Starting UTC Date and time for entry
+ End_Date: `2019-04-05T02:04:16Z` (required, string) - Ending UTC Date and time for entry
+ Comments: `noteworthy note` (required, string) - Any notes or description for the entry, maximum length of 3000 characters
+ Active: true (required, boolean) - Identifies if the entry is active
## IP Address Entry Pair (object)
A shorter version of the IP Address Object used to return the CIDR form and an entry to be used for future reference
### Properties
+ EntryID: `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the newly created Geo Location; opaque but likely a GUID
+ IPv4: `192.168.100.14/24` (string) - IP Address v4 in CIDR Format. Either IPv4 or IPv6 MUST be present.
## IP Address Array Pair (array)
+ `884d9804999fc47a3c2694e49ad2536a` (string, required) - a unique identifier for the newly created Geo Location; opaque but likely a GUID
+ `192.168.100.14/24` (string, required) - IP Address v4 in CIDR Format. Either IPv4 or IPv6 MUST be present.
## Geo Location (object)
The geolocation information referenced by Bouncer when building `ufw` rules
### Properties
+ Country Code: `CA` (required, string) - ISO Country Code
+ Start_Date: `2019-04-05T02:04:16Z` (required, string) - Starting UTC Date and time for entry
+ End_Date: `2019-04-05T02:04:16Z` (required, string) - Ending UTC Date and time for entry
+ Comments: `noteworthy note` (required, string) - Any notes or description for the entry, maximum length of 3000 characters
+ Active: true (required, boolean) - Identifies if the entry is active