Repository navigation
Expand file tree
/
Copy pathadmin.py
More file actions
2319 lines (1952 loc) · 79.1 KB
/
Copy pathadmin.py
File metadata and controls
2319 lines (1952 loc) · 79.1 KB
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
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
Duo Security Administration API reference client implementation.
<http://www.duosecurity.com/docs/adminapi>
USERS
User objects are returned in the following format:
{"username": <str:username>,
"user_id": <str:user id>,
"realname": <str:real name>,
"status": <str:status>,
"notes": <str:notes>,
"last_login": <int:unix timestamp>|None,
"phones": [<phone object>, ...],
"tokens": [<token object>, ...]}
User status is one of:
USER_STATUS_ACTIVE, USER_STATUS_BYPASS, USER_STATUS_DISABLED,
USER_STATUS_LOCKED_OUT
Note: USER_STATUS_LOCKED_OUT can only be set by the system. You cannot
set a user to be in the USER_STATUS_LOCKED_OUT state.
ENDPOINTS
Endpoint objects are returned in the following format:
{"username": <str:username>,
"email": <str:email>,
"epkey": <str:epkey>,
"os family": <str:os family>,
"os version": <str:os version>,
"model": <str:model>,
"type": <str:type>,
"browsers": [<browser object, ...]}
BROWSERS
Browser objects are returned in the following format:
{"browser family": <str:browser family>,
"browser version": <str:browser version>,
"flash version": <str: flash version>,
"java version": <str: java version>}
PHONES
Phone objects are returned in the following format:
{"phone_id": <str:phone id>,
"number": <str:phone number>,
"extension": <str:phone extension>|'',
"predelay": <str:predelay in seconds>|None,
"postdelay": <str:postdelay in seconds>|None,
"type": <str:phone type>|"Unknown",
"platform": <str:phone platform>|"Unknown",
"activated": <bool:is push enabled>,
"sms_passcodes_sent": <bool:have sms OTP been sent>,
"users": [<user object>, ...]}
DESKTOP_TOKENS
Desktop token objects are returned in the following format:
{"desktoptoken_id": <str:phone id>,
"name": <str>,
"platform": <str:phone platform>|"Unknown",
"type"": "Desktop Token",
"users": [<user object>, ...]}
TOKENS
Token objects are returned in the following format:
{"type": <str:token type>,
"serial": <str:token serial number>,
"token_id": <str:token id>,
"totp_step": <int:number of seconds> or null,
"users": [<user object>, ...]}
Token type is one of:
TOKEN_HOTP_6, TOKEN_HOTP_8, TOKEN_YUBIKEY
SETTINGS
Settings objects are returned in the following format:
{'inactive_user_expiration': <int:days until expiration>|0,
'sms_message': <str:sms message>,
'name': <str:name>,
'sms_batch': <int:sms batch size>,
'lockout_threshold': <int:lockout threshold>
'lockout_expire_duration': <int:minutes until expiration>|0,
'sms_expiration': <int:minutes until expiration>|0,
'log_retention_days': <int:days to retain>|0,
'sms_refresh': <bool:is sms refresh enabled (0|1)>,
'telephony_warning_min': <int:credits>',
'minimum_password_length': <int:minimum length>,
'password_requires_upper_alpha': <bool:is upper alpha character required>,
'password_requires_lower_alpha': <bool:is lower alpha character required>,
'password_requires_numeric': <bool:is numeric character required>,
'password_requires_special': <bool:is special character required>,
'security_checkup_enabled': <bool:is the security checkup feature enabled>,
}
INTEGRATIONS
Integration objects are returned in the following format:
{'adminapi_admins': <bool:admins permission (0|1)>,
'adminapi_info': <bool:info permission (0|1)>,
'adminapi_integrations': <bool:integrations permission (0|1)>,
'adminapi_read_log': <bool:read log permission (0|1)>,
'adminapi_read_resource': <bool:read resource permission (0|1)>,
'adminapi_settings': <bool:settings permission (0|1)>,
'adminapi_write_resource': <bool:write resource permission (0|1)>,
'self_service_allowed': <bool:self service permission (0|1)>,
'enroll_policy': <str:enroll policy (enroll|allow|deny)>,
'username_normalization_policy': <str:normalization policy (simple|none)>,
'greeting': <str:voice greeting>,
'integration_key': <str:integration key>,
'name': <str:integration name>,
'notes': <str:notes>,
'secret_key': <str:secret key>,
'type': <str:integration type>,
'visual_style': <str:visual style>}
See the adminapi docs for possible values for enroll_policy, visual_style, ip_whitelist,
and type.
ERRORS
Methods will raise a RuntimeError when an error is encountered. When
the call returns a HTTP status other than 200, error will be populated with
the following fields:
message - String description of the error encountered such as
"Received 404 Not Found"
status - HTTP status such as 404 (int)
reason - Status description such as "Not Found"
data - Detailed error code such as
{"code": 40401, "message": "Resource not found", "stat": "FAIL"}
"""
from __future__ import absolute_import
import six.moves.urllib
from . import client
import six
import warnings
import time
USER_STATUS_ACTIVE = 'active'
USER_STATUS_BYPASS = 'bypass'
USER_STATUS_DISABLED = 'disabled'
USER_STATUS_LOCKED_OUT = 'locked out'
TOKEN_HOTP_6 = 'h6'
TOKEN_HOTP_8 = 'h8'
TOKEN_YUBIKEY = 'yk'
VALID_AUTHLOG_REQUEST_PARAMS = [
'mintime',
'maxtime',
'limit',
'sort',
'next_offset',
'event_types',
'reasons',
'results',
'users',
'applications',
'groups',
'factors',
'api_version'
]
class Admin(client.Client):
account_id = None
def api_call(self, method, path, params):
if self.account_id is not None:
params['account_id'] = self.account_id
return super(Admin, self).api_call(method, path, params)
@classmethod
def _canonicalize_ip_whitelist(klass, ip_whitelist):
if isinstance(ip_whitelist, six.string_types):
return ip_whitelist
else:
return ','.join(ip_whitelist)
pass
@staticmethod
def _canonicalize_bypass_codes(codes):
if isinstance(codes, six.string_types):
return codes
else:
return ','.join([str(int(code)) for code in codes])
def get_administrator_log(self,
mintime=0):
"""
Returns administrator log events.
mintime - Fetch events only >= mintime (to avoid duplicate
records that have already been fetched)
Returns:
[
{'timestamp': <int:unix timestamp>,
'eventtype': "administrator",
'host': <str:hostname>,
'username': <str:username>,
'action': <str:action>,
'object': <str:object name>|None,
'description': <str:description>|None}, ...
]
<action> is one of:
'admin_login',
'admin_create', 'admin_update', 'admin_delete',
'customer_update',
'group_create', 'group_update', 'group_delete',
'integration_create', 'integration_update', 'integration_delete',
'phone_create', 'phone_update', 'phone_delete',
'user_create', 'user_update', 'user_delete'
Raises RuntimeError on error.
"""
# Sanity check mintime as unix timestamp, then transform to string
mintime = str(int(mintime))
params = {
'mintime': mintime,
}
response = self.json_api_call(
'GET',
'/admin/v1/logs/administrator',
params,
)
for row in response:
row['eventtype'] = 'administrator'
row['host'] = self.host
return response
def get_authentication_log(self, api_version=1, **kwargs):
"""
Returns authentication log events.
api_version - The api version of the handler to use. Currently, the
default api version is v1, but the v1 api will be
deprecated in a future version of the Duo Admin API.
Please migrate to the v2 api at your earliest convenience.
For details on the differences between v1 and v2,
please see Duo's Admin API documentation. (Optional)
API Version v1:
mintime - Fetch events only >= mintime (to avoid duplicate
records that have already been fetched)
Returns:
[
{'timestamp': <int:unix timestamp>,
'eventtype': "authentication",
'host': <str:host>,
'username': <str:username>,
'factor': <str:factor>,
'result': <str:result>,
'ip': <str:ip address>,
'new_enrollment': <bool:if event corresponds to enrollment>,
'integration': <str:integration>,
'location': {
'state': '<str:state>',
'city': '<str:city>',
'country': '<str:country>'
}
}]
Raises RuntimeError on error.
API Version v2:
mintime (required) - Unix timestamp in ms; fetch records >= mintime
maxtime (required) - Unix timestamp in ms; fetch records <= mintime
limit - Number of results to limit to
next_offset - Used to grab the next set of results from a previous response
sort - Sort order to be applied
users - List of user ids to filter on
groups - List of group ids to filter on
applications - List of application ids to filter on
results - List of results to filter to filter on
reasons - List of reasons to filter to filter on
factors - List of factors to filter on
event_types - List of event_types to filter on
Returns:
{
"authlogs": [
{
"access_device": {
"ip": <str:ip address>,
"location": {
"city": <str:city>,
"state": <str:state>,
"country": <str:country
}
},
"application": {
"key": <str:application id>,
"name": <str:application name>
},
"auth_device": {
"ip": <str:ip address>,
"location": {
"city": <str:city>,
"state": <str:state>,
"country": <str:country
},
"name": <str:device name>
},
"event_type": <str:type>,
"factor": <str:factor,
"reason": <str:reason>,
"result": <str:result>,
"timestamp": <int:unix timestamp>,
"user": {
"key": <str:user id>,
"name": <str:user name>
}
}
],
"metadata": {
"next_offset": [
<str>,
<str>
],
"total_objects": <int>
}
}
Raises RuntimeError on error.
"""
if api_version not in [1,2]:
raise ValueError("Invalid API Version")
params = {}
if api_version == 1: #v1
params['mintime'] = kwargs['mintime'] if 'mintime' in kwargs else 0;
# Sanity check mintime as unix timestamp, then transform to string
params['mintime'] = '{:d}'.format(int(params['mintime']))
warnings.warn(
'The v1 Admin API for retrieving authentication log events '
'will be deprecated in a future release of the Duo Admin API. '
'Please migrate to the v2 API.',
DeprecationWarning)
else: #v2
for k in kwargs:
if kwargs[k] is not None and k in VALID_AUTHLOG_REQUEST_PARAMS:
params[k] = kwargs[k]
if 'mintime' not in params:
params['mintime'] = (int(time.time()) - 86400) * 1000
# Sanity check mintime as unix timestamp, then transform to string
params['mintime'] = '{:d}'.format(int(params['mintime']))
if 'maxtime' not in params:
params['maxtime'] = int(time.time()) * 1000
# Sanity check maxtime as unix timestamp, then transform to string
params['maxtime'] = '{:d}'.format(int(params['maxtime']))
response = self.json_api_call(
'GET',
'/admin/v{}/logs/authentication'.format(api_version),
params,
)
if api_version == 1:
for row in response:
row['eventtype'] = 'authentication'
row['host'] = self.host
else:
for row in response['authlogs']:
row['eventtype'] = 'authentication'
row['host'] = self.host
return response
def get_telephony_log(self,
mintime=0):
"""
Returns telephony log events.
mintime - Fetch events only >= mintime (to avoid duplicate
records that have already been fetched)
Returns:
[
{'timestamp': <int:unix timestamp>,
'eventtype': "telephony",
'host': <str:host>,
'context': <str:context>,
'type': <str:type>,
'phone': <str:phone number>,
'credits': <str:credits>}, ...
]
Raises RuntimeError on error.
"""
# Sanity check mintime as unix timestamp, then transform to string
mintime = str(int(mintime))
params = {
'mintime': mintime,
}
response = self.json_api_call(
'GET',
'/admin/v1/logs/telephony',
params,
)
for row in response:
row['eventtype'] = 'telephony'
row['host'] = self.host
return response
def get_users(self):
"""
Returns list of users.
Returns list of user objects.
Raises RuntimeError on error.
"""
response = self.json_api_call('GET', '/admin/v1/users', {})
return response
def get_user_by_id(self, user_id):
"""
Returns user specified by user_id.
user_id - User to fetch
Returns user object.
Raises RuntimeError on error.
"""
user_id = six.moves.urllib.parse.quote_plus(str(user_id))
path = '/admin/v1/users/' + user_id
response = self.json_api_call('GET', path, {})
return response
def get_users_by_name(self, username):
"""
Returns user specified by username.
username - User to fetch
Returns a list of 0 or 1 user objects.
Raises RuntimeError on error.
"""
params = {
'username': username,
}
response = self.json_api_call('GET',
'/admin/v1/users',
params)
return response
def add_user(self, username, realname=None, status=None,
notes=None, email=None, firstname=None, lastname=None):
"""
Adds a user.
username - Username
realname - User's real name (optional)
status - User's status, defaults to USER_STATUS_ACTIVE
notes - Comment field (optional)
email - Email address (optional)
firstname - User's given name for ID Proofing (optional)
lastname - User's surname for ID Proofing (optional)
Returns newly created user object.
Raises RuntimeError on error.
"""
params = {
'username': username,
}
if realname is not None:
params['realname'] = realname
if status is not None:
params['status'] = status
if notes is not None:
params['notes'] = notes
if email is not None:
params['email'] = email
if firstname is not None:
params['firstname'] = firstname
if lastname is not None:
params['lastname'] = lastname
response = self.json_api_call('POST',
'/admin/v1/users',
params)
return response
def update_user(self, user_id, username=None, realname=None,
status=None, notes=None, email=None, firstname=None,
lastname=None):
"""
Update username, realname, status, or notes for a user.
user_id - User ID
username - Username (optional)
realname - User's real name (optional)
status - User's status, defaults to USER_STATUS_ACTIVE
notes - Comment field (optional)
email - Email address (optional)
firstname - User's given name for ID Proofing (optional)
lastname - User's surname for ID Proofing (optional)
Returns updated user object.
Raises RuntimeError on error.
"""
user_id = six.moves.urllib.parse.quote_plus(str(user_id))
path = '/admin/v1/users/' + user_id
params = {}
if username is not None:
params['username'] = username
if realname is not None:
params['realname'] = realname
if status is not None:
params['status'] = status
if notes is not None:
params['notes'] = notes
if email is not None:
params['email'] = email
if firstname is not None:
params['firstname'] = firstname
if lastname is not None:
params['lastname'] = lastname
response = self.json_api_call('POST', path, params)
return response
def delete_user(self, user_id):
"""
Deletes a user. If the user is already deleted, does nothing.
user_id - User ID
Raises RuntimeError on error.
"""
user_id = six.moves.urllib.parse.quote_plus(str(user_id))
path = '/admin/v1/users/' + user_id
return self.json_api_call('DELETE', path, {})
def enroll_user(self, username, email, valid_secs=None):
"""
Enroll a user and send them an enrollment email.
username - Username
email - Email address
valid_secs - Seconds before the enrollment link expires
(if 0 it never expires)
Returns nothing.
Raises RuntimeError on error.
"""
path = '/admin/v1/users/enroll'
params = {
'username': username,
'email': email,
}
if valid_secs is not None:
params['valid_secs'] = str(valid_secs)
return self.json_api_call('POST', path, params)
def add_user_bypass_codes(self, user_id, count=None, valid_secs=None, remaining_uses=None, codes=None):
"""
Replace a user's bypass codes with new codes.
user_id - User ID
count - Number of new codes to randomly generate
valid_secs - Seconds before codes expire (if 0 they will never expire)
remaining_uses - The number of times this code can be used (0 is unlimited)
codes - Optionally provide custom codes, otherwise will be random
count and codes are mutually exclusive
Returns a list of newly created codes.
Raises RuntimeError on error.
"""
user_id = six.moves.urllib.parse.quote_plus(str(user_id))
path = '/admin/v1/users/' + user_id + '/bypass_codes'
params = {}
if count is not None:
params['count'] = str(int(count))
if valid_secs is not None:
params['valid_secs'] = str(int(valid_secs))
if remaining_uses is not None:
params['reuse_count'] = str(int(remaining_uses))
if codes is not None:
params['codes'] = self._canonicalize_bypass_codes(codes)
return self.json_api_call('POST', path, params)
def get_user_bypass_codes(self, user_id):
""" Gets a list of bypass codes associated with a user.
Params:
user_id (str) - The user id.
Returns:
A list of bypass code dicts.
Notes:
Raises RuntimeError on error.
"""
user_id = six.moves.urllib.parse.quote_plus(str(user_id))
path = '/admin/v1/users/' + user_id + '/bypass_codes'
return self.json_api_call('GET', path, {})
def get_user_phones(self, user_id):
"""
Returns an array of phones associated with the user.
user_id - User ID
Returns list of phone objects.
Raises RuntimeError on error.
"""
user_id = six.moves.urllib.parse.quote_plus(str(user_id))
path = '/admin/v1/users/' + user_id + '/phones'
return self.json_api_call('GET', path, {})
def add_user_phone(self, user_id, phone_id):
"""
Associates a phone with a user.
user_id - User ID
phone_id - Phone ID
Returns nothing.
Raises RuntimeError on error.
"""
user_id = six.moves.urllib.parse.quote_plus(str(user_id))
path = '/admin/v1/users/' + user_id + '/phones'
params = {
'phone_id': phone_id,
}
return self.json_api_call('POST', path, params)
def delete_user_phone(self, user_id, phone_id):
"""
Dissociates a phone from a user.
user_id - User ID
phone_id - Phone ID
Returns nothing.
Raises RuntimeError on error.
"""
user_id = six.moves.urllib.parse.quote_plus(str(user_id))
path = '/admin/v1/users/' + user_id + '/phones/' + phone_id
params = {}
return self.json_api_call('DELETE', path,
params)
def get_user_tokens(self, user_id):
"""
Returns an array of hardware tokens associated with the user.
user_id - User ID
Returns list of hardware token objects.
Raises RuntimeError on error.
"""
user_id = six.moves.urllib.parse.quote_plus(str(user_id))
path = '/admin/v1/users/' + user_id + '/tokens'
params = {}
return self.json_api_call('GET', path,
params)
def add_user_token(self, user_id, token_id):
"""
Associates a hardware token with a user.
user_id - User ID
token_id - Token ID
Returns nothing.
Raises RuntimeError on error.
"""
user_id = six.moves.urllib.parse.quote_plus(str(user_id))
path = '/admin/v1/users/' + user_id + '/tokens'
params = {
'token_id': token_id,
}
return self.json_api_call('POST', path, params)
def delete_user_token(self, user_id, token_id):
"""
Dissociates a hardware token from a user.
user_id - User ID
token_id - Hardware token ID
Returns nothing.
Raises RuntimeError on error.
"""
user_id = six.moves.urllib.parse.quote_plus(str(user_id))
token_id = six.moves.urllib.parse.quote_plus(str(token_id))
path = '/admin/v1/users/' + user_id + '/tokens/' + token_id
return self.json_api_call('DELETE', path, {})
def get_user_u2ftokens(self, user_id):
""" Returns an array of u2ftokens associated
with a user.
Params:
user_id (str) - The user id.
Returns:
An array of u2ftoken dicts.
Notes:
Raises RuntimeError on error.
"""
user_id = six.moves.urllib.parse.quote_plus(str(user_id))
path = '/admin/v1/users/' + user_id + '/u2ftokens'
return self.json_api_call('GET', path, {})
def get_user_groups(self, user_id):
"""
Returns an array of groups associated with the user.
user_id - User ID
Returns list of groups objects.
Raises RuntimeError on error.
"""
user_id = six.moves.urllib.parse.quote_plus(str(user_id))
path = '/admin/v1/users/' + user_id + '/groups'
return self.json_api_call('GET', path, {})
def add_user_group(self, user_id, group_id):
"""
Associates a group with a user.
user_id - User ID
group_id - Group ID
Returns nothing.
Raises RuntimeError on error.
"""
user_id = six.moves.urllib.parse.quote_plus(str(user_id))
path = '/admin/v1/users/' + user_id + '/groups'
params = {'group_id': group_id}
return self.json_api_call('POST', path, params)
def delete_user_group(self, user_id, group_id):
"""
Dissociates a group from a user.
user_id - User ID
group_id - Group ID
Returns nothing.
Raises RuntimeError on error.
"""
user_id = six.moves.urllib.parse.quote_plus(str(user_id))
path = '/admin/v1/users/' + user_id + '/groups/' + group_id
params = {}
return self.json_api_call('DELETE', path, params)
def get_endpoints(self):
"""
Returns list of endpoints.
Raises RuntimeError on error.
"""
response = self.json_api_call('GET', '/admin/v1/endpoints', {})
return response
def get_phones(self):
"""
Returns list of phones.
Returns list of phone objects.
Raises RuntimeError on error.
"""
response = self.json_api_call('GET', '/admin/v1/phones', {})
return response
def get_phone_by_id(self, phone_id):
"""
Returns a phone specified by phone_id.
phone_id - Phone ID
Returns phone object.
Raises RuntimeError on error.
"""
path = '/admin/v1/phones/' + phone_id
response = self.json_api_call('GET', path, {})
return response
def get_phones_by_number(self, number, extension=None):
"""
Returns a phone specified by number and extension.
number - Phone number
extension - Phone number extension (optional)
Returns list of 0 or 1 phone objects.
Raises RuntimeError on error.
"""
path = '/admin/v1/phones'
params = {'number': number}
if extension is not None:
params['extension'] = extension
response = self.json_api_call('GET', path,
params)
return response
def add_phone(self,
number=None,
extension=None,
name=None,
type=None,
platform=None,
predelay=None,
postdelay=None):
"""
Adds a phone.
number - Phone number (optional).
extension - Phone number extension (optional).
name - Phone name (optional).
type - The phone type (optional).
platform - The phone platform (optional).
predelay - Number of seconds to wait after the number picks up
before dialing the extension (optional).
postdelay - Number of seconds to wait after the extension is
dialed before the speaking the prompt (optional).
Returns phone object.
Raises RuntimeError on error.
"""
path = '/admin/v1/phones'
params = {}
if number is not None:
params['number'] = number
if extension is not None:
params['extension'] = extension
if name is not None:
params['name'] = name
if type is not None:
params['type'] = type
if platform is not None:
params['platform'] = platform
if predelay is not None:
params['predelay'] = predelay
if postdelay is not None:
params['postdelay'] = postdelay
response = self.json_api_call('POST', path,
params)
return response
def update_phone(self, phone_id,
number=None,
extension=None,
name=None,
type=None,
platform=None,
predelay=None,
postdelay=None):
"""
Update a phone.
number - Phone number (optional)
extension - Phone number extension (optional).
name - Phone name (optional).
type - The phone type (optional).
platform - The phone platform (optional).
predelay - Number of seconds to wait after the number picks up
before dialing the extension (optional).
postdelay - Number of seconds to wait after the extension is
dialed before the speaking the prompt (optional).
Returns phone object.
Raises RuntimeError on error.
"""
phone_id = six.moves.urllib.parse.quote_plus(str(phone_id))
path = '/admin/v1/phones/' + phone_id
params = {}
if number is not None:
params['number'] = number
if extension is not None:
params['extension'] = extension
if name is not None:
params['name'] = name
if type is not None:
params['type'] = type
if platform is not None:
params['platform'] = platform
if predelay is not None:
params['predelay'] = predelay
if postdelay is not None:
params['postdelay'] = postdelay
response = self.json_api_call('POST', path,
params)
return response
def delete_phone(self, phone_id):
"""
Deletes a phone. If the phone has already been deleted, does nothing.
phone_id - Phone ID.
Raises RuntimeError on error.
"""
path = '/admin/v1/phones/' + phone_id
params = {}
return self.json_api_call('DELETE', path, params)
def send_sms_activation_to_phone(self, phone_id,
valid_secs=None,
install=None,
installation_msg=None,
activation_msg=None):
"""
Generate a Duo Mobile activation code and send it to the phone via
SMS, optionally sending an additional message with a PATH to
install Duo Mobile.
phone_id - Phone ID.
valid_secs - The number of seconds activation code should be valid for.
Default: 86400 seconds (one day).
install - '1' to also send an installation SMS message before the
activation message; '0' to not send. Default: '0'.
installation_msg - Custom installation message template to send to
the user if install was 1. Must contain
<insturl>, which is replaced with the
installation URL.
activation_msg - Custom activation message template. Must contain
<acturl>, which is replaced with the activation URL.
Returns: {
"activation_barcode": "https://api-abcdef.duosecurity.com/frame/qr?value=duo%3A%2F%2Factivation-code",
"activation_msg": "To activate the Duo Mobile app, click this link: https://m-abcdef.duosecurity.com/iphone/7dmi4Oowz5g3J47FARLs",
"installation_msg": "Welcome to Duo! To install the Duo Mobile app, click this link: http://m-abcdef.duosecurity.com",
"valid_secs": 3600
}
Raises RuntimeError on error.
"""
path = '/admin/v1/phones/' + phone_id + '/send_sms_activation'
params = {}
if valid_secs is not None:
params['valid_secs'] = str(valid_secs)
if install is not None:
params['install'] = str(int(bool(install)))