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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r"""
---
module: self_registered_portal
short_description: Resource module for Self Registered Portal
description:
- Manage operations create, update and delete of the resource Self Registered Portal.
- This API creates a self registered portal.
- This API deletes a self registered portal by ID.
- This API allows the client to update a self registered portal by ID.
version_added: '1.0.0'
extends_documentation_fragment:
- cisco.ise.module
author: Rafael Campos (@racampos)
options:
customizations:
description: Defines all of the Portal Customizations available.
suboptions:
globalCustomizations:
description: Self Registered Portal's globalCustomizations.
suboptions:
backgroundImage:
description: Self Registered Portal's backgroundImage.
suboptions:
data:
description: Represented as base 64 encoded string of the image byte
array.
type: str
type: dict
bannerImage:
description: Self Registered Portal's bannerImage.
suboptions:
data:
description: Represented as base 64 encoded string of the image byte
array.
type: str
type: dict
bannerTitle:
description: Self Registered Portal's bannerTitle.
type: str
contactText:
description: Self Registered Portal's contactText.
type: str
desktopLogoImage:
description: Self Registered Portal's desktopLogoImage.
suboptions:
data:
description: Represented as base 64 encoded string of the image byte
array.
type: str
type: dict
footerElement:
description: Self Registered Portal's footerElement.
type: str
mobileLogoImage:
description: Self Registered Portal's mobileLogoImage.
suboptions:
data:
description: Represented as base 64 encoded string of the image byte
array.
type: str
type: dict
type: dict
language:
description: This property is supported only for Read operation and it allows
to show the customizations in English. Other languages are not supported.
suboptions:
viewLanguage:
description: Self Registered Portal's viewLanguage.
type: str
type: dict
pageCustomizations:
description: Represent the entire page customization as a giant dictionary.
suboptions:
data:
description: The Dictionary will be exposed here as key value pair.
elements: dict
suboptions:
key:
description: Self Registered Portal's key.
type: str
value:
description: Self Registered Portal's value.
type: str
type: list
type: dict
portalTheme:
description: Self Registered Portal's portalTheme.
suboptions:
id:
description: Self Registered Portal's id.
type: str
name:
description: The system- or user-assigned name of the portal theme.
type: str
themeData:
description: A CSS file, represented as a Base64-encoded byte array.
type: str
type: dict
portalTweakSettings:
description: The Tweak Settings are a customization of the Portal Theme that
has been selected for the portal. When the Portal Theme selection is changed,
the Tweak Settings are overwritten to match the values in the theme. The Tweak
Settings can subsequently be changed by the user.
suboptions:
bannerColor:
description: Hex value of color.
type: str
bannerTextColor:
description: Self Registered Portal's bannerTextColor.
type: str
pageBackgroundColor:
description: Self Registered Portal's pageBackgroundColor.
type: str
pageLabelAndTextColor:
description: Self Registered Portal's pageLabelAndTextColor.
type: str
type: dict
type: dict
description:
description: Self Registered Portal's description.
type: str
id:
description: Self Registered Portal's id.
type: str
name:
description: Self Registered Portal's name.
type: str
portalTestUrl:
description: URL to bring up a test page for this portal.
type: str
portalType:
description: Allowed values - BYOD, - HOTSPOTGUEST, - MYDEVICE, - SELFREGGUEST,
- SPONSOR, - SPONSOREDGUEST.
type: str
settings:
description: Defines all of the settings groups available for a portal.
suboptions:
aupSettings:
description: Self Registered Portal's aupSettings.
suboptions:
displayFrequency:
description: How the AUP should be displayed, either on page or as a link.
Only valid if includeAup = true. Allowed Values - FIRSTLOGIN, - EVERYLOGIN,
- RECURRING.
type: str
displayFrequencyIntervalDays:
description: Number of days between AUP confirmations (when displayFrequency
= recurring).
type: int
includeAup:
description: Require the portal user to read and accept an AUP.
type: bool
requireAupScrolling:
description: Require the portal user to scroll to the end of the AUP. Only
valid if requireAupAcceptance = true.
type: bool
requireScrolling:
description: RequireScrolling flag.
type: bool
skipAupForEmployees:
description: Only valid if requireAupAcceptance = trueG.
type: bool
useDiffAupForEmployees:
description: Only valid if requireAupAcceptance = trueG.
type: bool
type: dict
authSuccessSettings:
description: Self Registered Portal's authSuccessSettings.
suboptions:
redirectUrl:
description: Self Registered Portal's redirectUrl.
type: str
successRedirect:
description: Self Registered Portal's successRedirect.
type: str
type: dict
byodSettings:
description: Configuration of BYOD Device Welcome, Registration and Success
steps.
suboptions:
byodRegistrationSettings:
description: Configuration of BYOD endpoint Registration step configuration.
suboptions:
endPointIdentityGroupId:
description: Identity group id for which endpoint belongs.
type: str
showDeviceID:
description: Display Device ID field during registration.
type: bool
type: dict
byodRegistrationSuccessSettings:
description: Configuration of BYOD endpoint Registration Success step configuration.
suboptions:
redirectUrl:
description: Target URL for redirection, used when successRedirect =
URL.
type: str
successRedirect:
description: After an Authentication Success where should device be
redirected. Allowed values - AUTHSUCCESSPAGE, - ORIGINATINGURL, -
URL.
type: str
type: dict
byodWelcomeSettings:
description: Configuration of BYOD endpoint welcome step configuration.
suboptions:
aupDisplay:
description: How the AUP should be displayed, either on page or as a
link. Only valid if includeAup = true. Allowed values - ONPAGE, -
ASLINK.
type: str
enableBYOD:
description: EnableBYOD flag.
type: bool
enableGuestAccess:
description: EnableGuestAccess flag.
type: bool
includeAup:
description: IncludeAup flag.
type: bool
requireAupAcceptance:
description: RequireAupAcceptance flag.
type: bool
requireMDM:
description: RequireMDM flag.
type: bool
requireScrolling:
description: Require BYOD devices to scroll down to the bottom of the
AUP, Only valid if includeAup = true.
type: bool
type: dict
type: dict
guestChangePasswordSettings:
description: Self Registered Portal's guestChangePasswordSettings.
suboptions:
allowChangePasswdAtFirstLogin:
description: Allow guest to change their own passwords.
type: bool
type: dict
guestDeviceRegistrationSettings:
description: Self Registered Portal's guestDeviceRegistrationSettings.
suboptions:
allowGuestsToRegisterDevices:
description: Allow guests to register devices.
type: bool
autoRegisterGuestDevices:
description: Automatically register guest devices.
type: bool
type: dict
loginPageSettings:
description: Portal Login Page settings groups follow.
suboptions:
accessCode:
description: Access code that must be entered by the portal user (only valid
if requireAccessCode = true).
type: str
allowAlternateGuestPortal:
description: AllowAlternateGuestPortal flag.
type: bool
allowForgotPassword:
description: AllowForgotPassword flag.
type: bool
allowGuestToChangePassword:
description: Require the portal user to enter an access code.
type: bool
allowGuestToCreateAccounts:
description: AllowGuestToCreateAccounts flag.
type: bool
allowGuestToUseSocialAccounts:
description: AllowGuestToUseSocialAccounts flag.
type: bool
allowShowGuestForm:
description: AllowShowGuestForm flag.
type: bool
alternateGuestPortal:
description: Self Registered Portal's alternateGuestPortal.
type: str
aupDisplay:
description: How the AUP should be displayed, either on page or as a link.
Only valid if includeAup = true. Allowed values - ONPAGE, - ASLINK.
type: str
includeAup:
description: Include an Acceptable Use Policy (AUP) that should be displayed
during login.
type: bool
maxFailedAttemptsBeforeRateLimit:
description: Maximum failed login attempts before rate limiting.
type: int
requireAccessCode:
description: Require the portal user to enter an access code.
type: bool
requireAupAcceptance:
description: Require the portal user to accept the AUP. Only valid if includeAup
= true.
type: bool
socialConfigs:
description: Self Registered Portal's socialConfigs.
elements: dict
suboptions:
socialMediaType:
description: Self Registered Portal's socialMediaType.
type: str
socialMediaValue:
description: Self Registered Portal's socialMediaValue.
type: str
type: list
timeBetweenLoginsDuringRateLimit:
description: Time between login attempts when rate limiting.
type: int
type: dict
portalSettings:
description: The port, interface, certificate, and other basic settings of a
portal.
suboptions:
allowedInterfaces:
description: Interfaces that the portal will be reachable on. Allowed values
- eth0, - eth1, - eth2, - eth3, - eth4, - eth5, - bond0, - bond1, - bond2.
elements: str
type: list
alwaysUsedLanguage:
description: Self Registered Portal's alwaysUsedLanguage.
type: str
assignedGuestTypeForEmployee:
description: Unique Id of a guest type. Employees using this portal as a
guest inherit login options from the guest type.
type: str
authenticationMethod:
description: Unique Id of the identity source sequence.
type: str
certificateGroupTag:
description: Logical name of the x.509 server certificate that will be used
for the portal.
type: str
displayLang:
description: Allowed values - USEBROWSERLOCALE, - ALWAYSUSE.
type: str
fallbackLanguage:
description: Used when displayLang = USEBROWSERLOCALE.
type: str
httpsPort:
description: The port number that the allowed interfaces will listen on.
Range from 8000 to 8999.
type: int
type: dict
postAccessBannerSettings:
description: Self Registered Portal's postAccessBannerSettings.
suboptions:
includePostAccessBanner:
description: IncludePostAccessBanner flag.
type: bool
type: dict
postLoginBannerSettings:
description: Self Registered Portal's postLoginBannerSettings.
suboptions:
includePostAccessBanner:
description: Include a Post-Login Banner page.
type: bool
type: dict
selfRegPageSettings:
description: Self Registered Portal's selfRegPageSettings.
suboptions:
accountValidityDuration:
description: Self-registered guest account is valid for this many account_validity_time_units.
type: int
accountValidityTimeUnits:
description: Time units for account_validity_duration. Allowed Values -
DAYS, - HOURS, - MINUTES.
type: str
allowGraceAccess:
description: AllowGraceAccess flag.
type: bool
approvalEmailAddresses:
description: Only valid if requireGuestApproval = true and sendApprovalRequestTo
= SELECTEDEMAILADDRESSES.
type: str
approveDenyLinksTimeUnits:
description: This attribute, along with approveDenyLinksValidFor, specifies
how long the link can be used. Only valid if requireGuestApproval = true.
Allowed Values - DAYS, - HOURS, - MINUTES.
type: str
approveDenyLinksValidFor:
description: This attribute, along with approveDenyLinksTimeUnits, specifies
how long the link can be used. Only valid if requireGuestApproval = true.
type: int
assignGuestsToGuestType:
description: Guests are assigned to this guest type.
type: str
aupDisplay:
description: How the AUP should be displayed, either on page or as a link.
Only valid if includeAup = true. Allowed values - ONPAGE, - ASLINK.
type: str
authenticateSponsorsUsingPortalList:
description: AuthenticateSponsorsUsingPortalList flag.
type: bool
autoLoginSelfWait:
description: Allow guests to login automatically from self-registration
after sponsor's approval. No need to provide the credentials by guest
to login.
type: bool
autoLoginTimePeriod:
description: Waiting period for auto login until sponsor's approval. If
time exceeds, guest has to login manually by providing the credentials.
Default value is 5 minutes.
type: int
credentialNotificationUsingEmail:
description: If true, send credential notification upon approval using email.
Only valid if requireGuestApproval = true.
type: bool
credentialNotificationUsingSMS:
description: If true, send credential notification upon approval using SMS.
Only valid if requireGuestApproval = true.
type: bool
enableGuestEmailBlacklist:
description: Disallow guests with an e-mail address from selected domains.
type: bool
enableGuestEmailWhitelist:
description: Allow guests with an e-mail address from selected domains.
type: bool
fieldCompany:
description: Self Registered Portal's fieldCompany.
suboptions:
include:
description: Include flag.
type: bool
require:
description: Only applicable if include = true.
type: bool
type: dict
fieldEmailAddr:
description: Self Registered Portal's fieldEmailAddr.
suboptions:
include:
description: Include flag.
type: bool
require:
description: Only applicable if include = true.
type: bool
type: dict
fieldFirstName:
description: Self Registered Portal's fieldFirstName.
suboptions:
include:
description: Include flag.
type: bool
require:
description: Only applicable if include = true.
type: bool
type: dict
fieldLastName:
description: Self Registered Portal's fieldLastName.
suboptions:
include:
description: Include flag.
type: bool
require:
description: Only applicable if include = true.
type: bool
type: dict
fieldLocation:
description: Self Registered Portal's fieldLocation.
suboptions:
include:
description: Include flag.
type: bool
require:
description: Only applicable if include = true.
type: bool
type: dict
fieldPersonBeingVisited:
description: Self Registered Portal's fieldPersonBeingVisited.
suboptions:
include:
description: Include flag.
type: bool
require:
description: Only applicable if include = true.
type: bool
type: dict
fieldPhoneNo:
description: Self Registered Portal's fieldPhoneNo.
suboptions:
include:
description: Include flag.
type: bool
require:
description: Only applicable if include = true.
type: bool
type: dict
fieldReasonForVisit:
description: Self Registered Portal's fieldReasonForVisit.
suboptions:
include:
description: Include flag.
type: bool
require:
description: Only applicable if include = true.
type: bool
type: dict
fieldSMSProvider:
description: Self Registered Portal's fieldSMSProvider.
suboptions:
include:
description: Include flag.
type: bool
require:
description: Only applicable if include = true.
type: bool
type: dict
fieldUserName:
description: Self Registered Portal's fieldUserName.
suboptions:
include:
description: Include flag.
type: bool
require:
description: Only applicable if include = true.
type: bool
type: dict
graceAccessExpireInterval:
description: Self Registered Portal's graceAccessExpireInterval.
type: int
graceAccessSendAccountExpiration:
description: GraceAccessSendAccountExpiration flag.
type: bool
guestEmailBlacklistDomains:
description: Disallow guests with an e-mail address from selected domains.
elements: str
type: list
guestEmailWhitelistDomains:
description: Self-registered guests whose e-mail address is in one of these
domains will be allowed. Only valid if enableGuestEmailWhitelist = true.
elements: str
type: list
includeAup:
description: Include an Acceptable Use Policy (AUP) that should be displayed
during login.
type: bool
postRegistrationRedirect:
description: After the registration submission direct the guest user to
one of the following pages. Only valid if requireGuestApproval = true.
Allowed Values - SELFREGISTRATIONSUCCESS, - LOGINPAGEWITHINSTRUCTIONS
- URL.
type: str
postRegistrationRedirectUrl:
description: URL where guest user is redirected after registration. Only
valid if requireGuestApproval = true and postRegistrationRedirect = URL.
type: str
registrationCode:
description: The registration code that the guest user must enter.
type: str
requireApproverToAuthenticate:
description: When self-registered guests require approval, an approval request
is e-mailed to one or more sponsor users. If the Cisco ISE Administrator
chooses to include an approval link in the e-mail, a sponsor user who
clicks the link will be required to enter their username and password
if this attribute is true. Only valid if requireGuestApproval = true.
type: bool
requireAupAcceptance:
description: Require the portal user to accept the AUP. Only valid if includeAup
= true.
type: bool
requireGuestApproval:
description: Require self-registered guests to be approved if true.
type: bool
requireRegistrationCode:
description: Self-registered guests are required to enter a registration
code.
type: bool
selectableLocations:
description: Guests can choose from these locations to set their time zone.
elements: str
type: list
selectableSMSProviders:
description: This attribute is an array of SMS provider names.
elements: str
type: list
sendApprovalRequestTo:
description: Specifies where approval requests are sent. Only valid if requireGuestApproval
= true. Allowed Values - SELECTEDEMAILADDRESSES, - PERSONBEINGVISITED.
type: str
sponsorPortalList:
description: Self Registered Portal's sponsorPortalList.
elements: str
type: list
type: dict
selfRegSuccessSettings:
description: Self Registered Portal's selfRegSuccessSettings.
suboptions:
allowGuestLoginFromSelfregSuccessPage:
description: AllowGuestLoginFromSelfregSuccessPage flag.
type: bool
allowGuestSendSelfUsingEmail:
description: AllowGuestSendSelfUsingEmail flag.
type: bool
allowGuestSendSelfUsingPrint:
description: AllowGuestSendSelfUsingPrint flag.
type: bool
allowGuestSendSelfUsingSMS:
description: AllowGuestSendSelfUsingSMS flag.
type: bool
aupOnPage:
description: AupOnPage flag.
type: bool
includeAup:
description: IncludeAup flag.
type: bool
includeCompany:
description: IncludeCompany flag.
type: bool
includeEmailAddr:
description: IncludeEmailAddr flag.
type: bool
includeFirstName:
description: IncludeFirstName flag.
type: bool
includeLastName:
description: IncludeLastName flag.
type: bool
includeLocation:
description: IncludeLocation flag.
type: bool
includePassword:
description: IncludePassword flag.
type: bool
includePersonBeingVisited:
description: IncludePersonBeingVisited flag.
type: bool
includePhoneNo:
description: IncludePhoneNo flag.
type: bool
includeReasonForVisit:
description: IncludeReasonForVisit flag.
type: bool
includeSMSProvider:
description: IncludeSMSProvider flag.
type: bool
includeUserName:
description: IncludeUserName flag.
type: bool
requireAupAcceptance:
description: RequireAupAcceptance flag.
type: bool
requireAupScrolling:
description: RequireAupScrolling flag.
type: bool
type: dict
supportInfoSettings:
description: Self Registered Portal's supportInfoSettings.
suboptions:
defaultEmptyFieldValue:
description: The default value displayed for an empty field. Only valid
when emptyFieldDisplay = DISPLAYWITHDEFAULTVALUE.
type: str
emptyFieldDisplay:
description: Specifies how empty fields are handled on the Support Information
Page. Allowed values - HIDE, - DISPLAYWITHNOVALUE, - DISPLAYWITHDEFAULTVALUE.
type: str
includeBrowserUserAgent:
description: IncludeBrowserUserAgent flag.
type: bool
includeFailureCode:
description: IncludeFailureCode flag.
type: bool
includeIpAddress:
description: IncludeIpAddress flag.
type: bool
includeMacAddr:
description: IncludeMacAddr flag.
type: bool
includePolicyServer:
description: IncludePolicyServer flag.
type: bool
includeSupportInfoPage:
description: IncludeSupportInfoPage flag.
type: bool
type: dict
type: dict
requirements:
- ciscoisesdk >= 2.2.1
- python >= 3.5
seealso:
- name: Cisco ISE documentation for SelfRegisteredPortal
description: Complete reference of the SelfRegisteredPortal API.
link: https://developer.cisco.com/docs/identity-services-engine/v1/#!selfregportal
notes:
- SDK Method used are
self_registered_portal.SelfRegisteredPortal.create_self_registered_portal,
self_registered_portal.SelfRegisteredPortal.delete_self_registered_portal_by_id,
self_registered_portal.SelfRegisteredPortal.update_self_registered_portal_by_id,
- Paths used are
post /ers/config/selfregportal,
delete /ers/config/selfregportal/{id},
put /ers/config/selfregportal/{id},
"""
EXAMPLES = r"""
- name: Update by id
cisco.ise.self_registered_portal:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
customizations:
globalCustomizations:
backgroundImage:
data: string
bannerImage:
data: string
bannerTitle: string
contactText: string
desktopLogoImage:
data: string
footerElement: string
mobileLogoImage:
data: string
language:
viewLanguage: string
pageCustomizations:
data:
- key: string
value: string
portalTheme:
id: string
name: string
themeData: string
portalTweakSettings:
bannerColor: string
bannerTextColor: string
pageBackgroundColor: string
pageLabelAndTextColor: string
description: string
id: string
name: string
portalTestUrl: string
portalType: string
settings:
aupSettings:
displayFrequency: string
displayFrequencyIntervalDays: 0
includeAup: true
requireAupScrolling: true
requireScrolling: true
skipAupForEmployees: true
useDiffAupForEmployees: true
authSuccessSettings:
redirectUrl: string
successRedirect: string
byodSettings:
byodRegistrationSettings:
endPointIdentityGroupId: string
showDeviceID: true
byodRegistrationSuccessSettings:
redirectUrl: string
successRedirect: string
byodWelcomeSettings:
aupDisplay: string
enableBYOD: true
enableGuestAccess: true
includeAup: true
requireAupAcceptance: true
requireMDM: true
requireScrolling: true
guestChangePasswordSettings:
allowChangePasswdAtFirstLogin: true
guestDeviceRegistrationSettings:
allowGuestsToRegisterDevices: true
autoRegisterGuestDevices: true
loginPageSettings:
accessCode: string
allowAlternateGuestPortal: true
allowForgotPassword: true
allowGuestToChangePassword: true
allowGuestToCreateAccounts: true
allowGuestToUseSocialAccounts: true
allowShowGuestForm: true
alternateGuestPortal: string
aupDisplay: string
includeAup: true
maxFailedAttemptsBeforeRateLimit: 0
requireAccessCode: true
requireAupAcceptance: true
socialConfigs:
- socialMediaType: string
socialMediaValue: string
timeBetweenLoginsDuringRateLimit: 0
portalSettings:
allowedInterfaces:
- string
alwaysUsedLanguage: string
assignedGuestTypeForEmployee: string
authenticationMethod: string
certificateGroupTag: string
displayLang: string
fallbackLanguage: string
httpsPort: 0
postAccessBannerSettings:
includePostAccessBanner: true
postLoginBannerSettings:
includePostAccessBanner: true
selfRegPageSettings:
accountValidityDuration: 0
accountValidityTimeUnits: string
allowGraceAccess: true
approvalEmailAddresses: string
approveDenyLinksTimeUnits: string
approveDenyLinksValidFor: 0
assignGuestsToGuestType: string
aupDisplay: string
authenticateSponsorsUsingPortalList: true
autoLoginSelfWait: true
autoLoginTimePeriod: 0
credentialNotificationUsingEmail: true
credentialNotificationUsingSms: true
enableGuestEmailBlacklist: true
enableGuestEmailWhitelist: true
fieldCompany:
include: true
require: true
fieldEmailAddr:
include: true
require: true
fieldFirstName:
include: true
require: true
fieldLastName:
include: true
require: true
fieldLocation:
include: true
require: true
fieldPersonBeingVisited:
include: true
require: true
fieldPhoneNo:
include: true
require: true
fieldReasonForVisit:
include: true
require: true
fieldSmsProvider:
include: true
require: true
fieldUserName:
include: true
require: true
graceAccessExpireInterval: 0
graceAccessSendAccountExpiration: true
guestEmailBlacklistDomains:
- string
guestEmailWhitelistDomains:
- string
includeAup: true
postRegistrationRedirect: string
postRegistrationRedirectUrl: string
registrationCode: string
requireApproverToAuthenticate: true
requireAupAcceptance: true
requireGuestApproval: true
requireRegistrationCode: true
selectableLocations:
- string
selectableSmsProviders:
- string
sendApprovalRequestTo: string
sponsorPortalList:
- string
selfRegSuccessSettings:
allowGuestLoginFromSelfregSuccessPage: true
allowGuestSendSelfUsingEmail: true
allowGuestSendSelfUsingPrint: true
allowGuestSendSelfUsingSms: true
aupOnPage: true
includeAup: true
includeCompany: true
includeEmailAddr: true
includeFirstName: true
includeLastName: true
includeLocation: true
includePassword: true
includePersonBeingVisited: true
includePhoneNo: true
includeReasonForVisit: true
includeSmsProvider: true
includeUserName: true
requireAupAcceptance: true
requireAupScrolling: true
supportInfoSettings:
defaultEmptyFieldValue: string
emptyFieldDisplay: string
includeBrowserUserAgent: true
includeFailureCode: true
includeIpAddress: true
includeMacAddr: true
includePolicyServer: true
includeSupportInfoPage: true
- name: Delete by id
cisco.ise.self_registered_portal:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: absent
id: string
- name: Create
cisco.ise.self_registered_portal:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
state: present
customizations:
globalCustomizations:
backgroundImage:
data: string
bannerImage:
data: string
bannerTitle: string
contactText: string
desktopLogoImage:
data: string
footerElement: string
mobileLogoImage:
data: string
language:
viewLanguage: string
pageCustomizations:
data:
- key: string
value: string
portalTheme:
id: string
name: string
themeData: string
portalTweakSettings:
bannerColor: string
bannerTextColor: string
pageBackgroundColor: string
pageLabelAndTextColor: string
description: string
name: string
portalTestUrl: string
portalType: string
settings:
aupSettings:
displayFrequency: string
displayFrequencyIntervalDays: 0
includeAup: true
requireAupScrolling: true
requireScrolling: true
skipAupForEmployees: true
useDiffAupForEmployees: true
authSuccessSettings:
redirectUrl: string
successRedirect: string
byodSettings:
byodRegistrationSettings:
endPointIdentityGroupId: string
showDeviceID: true
byodRegistrationSuccessSettings:
redirectUrl: string
successRedirect: string
byodWelcomeSettings:
aupDisplay: string
enableBYOD: true
enableGuestAccess: true
includeAup: true
requireAupAcceptance: true
requireMDM: true
requireScrolling: true
guestChangePasswordSettings:
allowChangePasswdAtFirstLogin: true
guestDeviceRegistrationSettings:
allowGuestsToRegisterDevices: true
autoRegisterGuestDevices: true
loginPageSettings:
accessCode: string
allowAlternateGuestPortal: true
allowForgotPassword: true
allowGuestToChangePassword: true
allowGuestToCreateAccounts: true
allowGuestToUseSocialAccounts: true
allowShowGuestForm: true
alternateGuestPortal: string
aupDisplay: string
includeAup: true
maxFailedAttemptsBeforeRateLimit: 0
requireAccessCode: true
requireAupAcceptance: true
socialConfigs:
- socialMediaType: string
socialMediaValue: string
timeBetweenLoginsDuringRateLimit: 0
portalSettings:
allowedInterfaces:
- string
alwaysUsedLanguage: string
assignedGuestTypeForEmployee: string
authenticationMethod: string
certificateGroupTag: string
displayLang: string
fallbackLanguage: string
httpsPort: 0
postAccessBannerSettings:
includePostAccessBanner: true
postLoginBannerSettings:
includePostAccessBanner: true
selfRegPageSettings:
accountValidityDuration: 0
accountValidityTimeUnits: string
allowGraceAccess: true
approvalEmailAddresses: string
approveDenyLinksTimeUnits: string
approveDenyLinksValidFor: 0
assignGuestsToGuestType: string
aupDisplay: string
authenticateSponsorsUsingPortalList: true
autoLoginSelfWait: true
autoLoginTimePeriod: 0
credentialNotificationUsingEmail: true
credentialNotificationUsingSms: true
enableGuestEmailBlacklist: true
enableGuestEmailWhitelist: true
fieldCompany:
include: true
require: true
fieldEmailAddr:
include: true
require: true
fieldFirstName:
include: true
require: true
fieldLastName:
include: true
require: true
fieldLocation:
include: true
require: true
fieldPersonBeingVisited:
include: true
require: true
fieldPhoneNo:
include: true
require: true
fieldReasonForVisit:
include: true
require: true
fieldSmsProvider:
include: true
require: true
fieldUserName:
include: true
require: true
graceAccessExpireInterval: 0
graceAccessSendAccountExpiration: true
guestEmailBlacklistDomains:
- string
guestEmailWhitelistDomains:
- string
includeAup: true
postRegistrationRedirect: string
postRegistrationRedirectUrl: string
registrationCode: string
requireApproverToAuthenticate: true
requireAupAcceptance: true
requireGuestApproval: true
requireRegistrationCode: true
selectableLocations:
- string
selectableSmsProviders:
- string
sendApprovalRequestTo: string
sponsorPortalList:
- string
selfRegSuccessSettings:
allowGuestLoginFromSelfregSuccessPage: true
allowGuestSendSelfUsingEmail: true
allowGuestSendSelfUsingPrint: true
allowGuestSendSelfUsingSms: true
aupOnPage: true
includeAup: true
includeCompany: true
includeEmailAddr: true
includeFirstName: true
includeLastName: true
includeLocation: true
includePassword: true
includePersonBeingVisited: true
includePhoneNo: true
includeReasonForVisit: true
includeSmsProvider: true
includeUserName: true
requireAupAcceptance: true
requireAupScrolling: true
supportInfoSettings:
defaultEmptyFieldValue: string
emptyFieldDisplay: string
includeBrowserUserAgent: true
includeFailureCode: true
includeIpAddress: true
includeMacAddr: true
includePolicyServer: true
includeSupportInfoPage: true
"""
RETURN = r"""
ise_response:
description: A dictionary or list with the response returned by the Cisco ISE Python SDK
returned: always
type: dict
sample: >
{
"id": "string",
"name": "string",
"description": "string",
"portalType": "string",
"portalTestUrl": "string",
"settings": {
"portalSettings": {
"httpsPort": 0,
"allowedInterfaces": [
"string"
],
"certificateGroupTag": "string",
"authenticationMethod": "string",
"assignedGuestTypeForEmployee": "string",
"displayLang": "string",
"fallbackLanguage": "string",
"alwaysUsedLanguage": "string"
},
"loginPageSettings": {
"requireAccessCode": true,
"maxFailedAttemptsBeforeRateLimit": 0,
"timeBetweenLoginsDuringRateLimit": 0,
"includeAup": true,
"aupDisplay": "string",
"requireAupAcceptance": true,
"accessCode": "string",
"allowGuestToCreateAccounts": true,
"allowForgotPassword": true,
"allowGuestToChangePassword": true,
"allowAlternateGuestPortal": true,
"alternateGuestPortal": "string",
"allowGuestToUseSocialAccounts": true,
"allowShowGuestForm": true,
"socialConfigs": [
{
"socialMediaType": "string",
"socialMediaValue": "string"
}
]
},
"selfRegPageSettings": {
"assignGuestsToGuestType": "string",
"accountValidityDuration": 0,
"accountValidityTimeUnits": "string",
"requireRegistrationCode": true,
"registrationCode": "string",
"fieldUserName": {
"include": true,
"require": true
},
"fieldFirstName": {
"include": true,
"require": true
},
"fieldLastName": {
"include": true,
"require": true
},
"fieldEmailAddr": {
"include": true,
"require": true
},
"fieldPhoneNo": {
"include": true,
"require": true
},
"fieldCompany": {
"include": true,
"require": true
},
"fieldLocation": {
"include": true,
"require": true
},
"selectableLocations": [
"string"
],
"fieldSmsProvider": {
"include": true,
"require": true
},
"selectableSmsProviders": [
"string"
],
"fieldPersonBeingVisited": {
"include": true,
"require": true
},
"fieldReasonForVisit": {
"include": true,
"require": true
},
"includeAup": true,
"aupDisplay": "string",
"requireAupAcceptance": true,
"enableGuestEmailWhitelist": true,
"guestEmailWhitelistDomains": [
"string"
],
"enableGuestEmailBlacklist": true,
"guestEmailBlacklistDomains": [
"string"
],
"requireGuestApproval": true,
"autoLoginSelfWait": true,
"autoLoginTimePeriod": 0,
"allowGraceAccess": true,
"graceAccessExpireInterval": 0,
"graceAccessSendAccountExpiration": true,
"sendApprovalRequestTo": "string",
"approvalEmailAddresses": "string",
"postRegistrationRedirect": "string",
"postRegistrationRedirectUrl": "string",
"credentialNotificationUsingEmail": true,
"credentialNotificationUsingSms": true,
"approveDenyLinksValidFor": 0,
"approveDenyLinksTimeUnits": "string",
"requireApproverToAuthenticate": true,
"authenticateSponsorsUsingPortalList": true,
"sponsorPortalList": [
"string"
]
},
"selfRegSuccessSettings": {
"includeUserName": true,
"includePassword": true,
"includeFirstName": true,
"includeLastName": true,
"includeEmailAddr": true,
"includePhoneNo": true,
"includeCompany": true,
"includeLocation": true,
"includeSmsProvider": true,
"includePersonBeingVisited": true,
"includeReasonForVisit": true,
"allowGuestSendSelfUsingPrint": true,
"allowGuestSendSelfUsingEmail": true,
"allowGuestSendSelfUsingSms": true,
"includeAup": true,
"aupOnPage": true,
"requireAupAcceptance": true,
"requireAupScrolling": true,
"allowGuestLoginFromSelfregSuccessPage": true
},
"aupSettings": {
"includeAup": true,
"useDiffAupForEmployees": true,
"skipAupForEmployees": true,
"requireScrolling": true,
"requireAupScrolling": true,
"displayFrequency": "string",
"displayFrequencyIntervalDays": 0
},
"guestChangePasswordSettings": {
"allowChangePasswdAtFirstLogin": true
},
"guestDeviceRegistrationSettings": {
"autoRegisterGuestDevices": true,
"allowGuestsToRegisterDevices": true
},
"byodSettings": {
"byodWelcomeSettings": {
"enableBYOD": true,
"enableGuestAccess": true,
"requireMDM": true,
"includeAup": true,
"aupDisplay": "string",
"requireAupAcceptance": true,
"requireScrolling": true
},
"byodRegistrationSettings": {
"showDeviceID": true,
"endPointIdentityGroupId": "string"
},
"byodRegistrationSuccessSettings": {
"successRedirect": "string",
"redirectUrl": "string"
}
},
"postLoginBannerSettings": {
"includePostAccessBanner": true
},
"postAccessBannerSettings": {
"includePostAccessBanner": true
},
"authSuccessSettings": {
"successRedirect": "string",
"redirectUrl": "string"
},
"supportInfoSettings": {
"includeSupportInfoPage": true,
"includeMacAddr": true,
"includeIpAddress": true,
"includeBrowserUserAgent": true,
"includePolicyServer": true,
"includeFailureCode": true,
"emptyFieldDisplay": "string",
"defaultEmptyFieldValue": "string"
}
},
"customizations": {
"portalTheme": {
"id": "string",
"name": "string",
"themeData": "string"
},
"portalTweakSettings": {
"bannerColor": "string",
"bannerTextColor": "string",
"pageBackgroundColor": "string",
"pageLabelAndTextColor": "string"
},
"language": {
"viewLanguage": "string"
},
"globalCustomizations": {
"mobileLogoImage": {
"data": "string"
},
"desktopLogoImage": {
"data": "string"
},
"bannerImage": {
"data": "string"
},
"backgroundImage": {
"data": "string"
},
"bannerTitle": "string",
"contactText": "string",
"footerElement": "string"
},
"pageCustomizations": {
"data": [
{
"key": "string",
"value": "string"
}
]
}
},
"link": {
"rel": "string",
"href": "string",
"type": "string"
}
}
ise_update_response:
description: A dictionary or list with the response returned by the Cisco ISE Python SDK
returned: always
version_added: '1.1.0'
type: dict
sample: >
{
"UpdatedFieldsList": {
"updatedField": [
{
"field": "string",
"oldValue": "string",
"newValue": "string"
}
],
"field": "string",
"oldValue": "string",
"newValue": "string"
}
}
"""
|