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
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
|
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>onelogin.saml2 package — SAML Python2/3 Toolkit 1 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=404a92a0"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="onelogin package" href="onelogin.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
SAML Python2/3 Toolkit
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="onelogin.html">onelogin package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="onelogin.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">onelogin.saml2 package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-onelogin.saml2.auth">onelogin.saml2.auth module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-onelogin.saml2.authn_request">onelogin.saml2.authn_request module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-onelogin.saml2.compat">onelogin.saml2.compat module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-onelogin.saml2.constants">onelogin.saml2.constants module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-onelogin.saml2.errors">onelogin.saml2.errors module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-onelogin.saml2.idp_metadata_parser">onelogin.saml2.idp_metadata_parser module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-onelogin.saml2.logout_request">onelogin.saml2.logout_request module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-onelogin.saml2.logout_response">onelogin.saml2.logout_response module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-onelogin.saml2.metadata">onelogin.saml2.metadata module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-onelogin.saml2.response">onelogin.saml2.response module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-onelogin.saml2.settings">onelogin.saml2.settings module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-onelogin.saml2.utils">onelogin.saml2.utils module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-onelogin.saml2.xml_templates">onelogin.saml2.xml_templates module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-onelogin.saml2.xml_utils">onelogin.saml2.xml_utils module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-onelogin.saml2.xmlparser">onelogin.saml2.xmlparser module</a></li>
<li class="toctree-l4"><a class="reference internal" href="#module-onelogin.saml2">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="onelogin.html#module-onelogin">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">SAML Python2/3 Toolkit</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="onelogin.html">onelogin package</a></li>
<li class="breadcrumb-item active">onelogin.saml2 package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/onelogin.saml2.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="onelogin-saml2-package">
<h1>onelogin.saml2 package<a class="headerlink" href="#onelogin-saml2-package" title="Permalink to this heading"></a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this heading"></a></h2>
</section>
<section id="module-onelogin.saml2.auth">
<span id="onelogin-saml2-auth-module"></span><h2>onelogin.saml2.auth module<a class="headerlink" href="#module-onelogin.saml2.auth" title="Permalink to this heading"></a></h2>
<p>OneLogin_Saml2_Auth class</p>
<p>Main class of SAML Python Toolkit.</p>
<p>Initializes the SP SAML instance</p>
<dl class="py class">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">onelogin.saml2.auth.</span></span><span class="sig-name descname"><span class="pre">OneLogin_Saml2_Auth</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">old_settings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_base_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This class implements the SP SAML instance.</p>
<p>Defines the methods that you can invoke in your application in
order to add SAML support (initiates SSO, initiates SLO, processes a
SAML Response, a Logout Request or a Logout Response).</p>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.add_request_signature">
<span class="sig-name descname"><span class="pre">add_request_signature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sign_algorithm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'http://www.w3.org/2001/04/xmldsig-more#rsa-sha256'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.add_request_signature"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.add_request_signature" title="Permalink to this definition"></a></dt>
<dd><p>Builds the Signature of the SAML Request.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>request_data</strong> (<em>dict</em>) – The Request parameters</p></li>
<li><p><strong>sign_algorithm</strong> (<em>string</em>) – Signature algorithm method</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.add_response_signature">
<span class="sig-name descname"><span class="pre">add_response_signature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response_data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sign_algorithm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'http://www.w3.org/2001/04/xmldsig-more#rsa-sha256'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.add_response_signature"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.add_response_signature" title="Permalink to this definition"></a></dt>
<dd><p>Builds the Signature of the SAML Response.
:param response_data: The Response parameters
:type response_data: dict</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>sign_algorithm</strong> (<em>string</em>) – Signature algorithm method</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.authn_request_class">
<span class="sig-name descname"><span class="pre">authn_request_class</span></span><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.authn_request_class" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="#onelogin.saml2.authn_request.OneLogin_Saml2_Authn_Request" title="onelogin.saml2.authn_request.OneLogin_Saml2_Authn_Request"><code class="xref py py-class docutils literal notranslate"><span class="pre">OneLogin_Saml2_Authn_Request</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_attribute">
<span class="sig-name descname"><span class="pre">get_attribute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_attribute"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_attribute" title="Permalink to this definition"></a></dt>
<dd><p>Returns the requested SAML attribute.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>name</strong> (<em>string</em>) – Name of the attribute</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Attribute value(s) if exists or None</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_attributes">
<span class="sig-name descname"><span class="pre">get_attributes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_attributes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_attributes" title="Permalink to this definition"></a></dt>
<dd><p>Returns the set of SAML attributes.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>SAML attributes</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_errors">
<span class="sig-name descname"><span class="pre">get_errors</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_errors"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_errors" title="Permalink to this definition"></a></dt>
<dd><p>Returns a list with code errors if something went wrong</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>List of errors</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_friendlyname_attribute">
<span class="sig-name descname"><span class="pre">get_friendlyname_attribute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">friendlyname</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_friendlyname_attribute"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_friendlyname_attribute" title="Permalink to this definition"></a></dt>
<dd><p>Returns the requested SAML attribute searched by FriendlyName.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>friendlyname</strong> (<em>string</em>) – FriendlyName of the attribute</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Attribute value(s) if exists or None</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_friendlyname_attributes">
<span class="sig-name descname"><span class="pre">get_friendlyname_attributes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_friendlyname_attributes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_friendlyname_attributes" title="Permalink to this definition"></a></dt>
<dd><p>Returns the set of SAML attributes indexed by FiendlyName.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>SAML attributes</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_assertion_id">
<span class="sig-name descname"><span class="pre">get_last_assertion_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_last_assertion_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_assertion_id" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The ID of the last assertion processed.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_assertion_issue_instant">
<span class="sig-name descname"><span class="pre">get_last_assertion_issue_instant</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_last_assertion_issue_instant"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_assertion_issue_instant" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The IssueInstant of the last assertion processed.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>unix/posix timestamp|None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_assertion_not_on_or_after">
<span class="sig-name descname"><span class="pre">get_last_assertion_not_on_or_after</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_last_assertion_not_on_or_after"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_assertion_not_on_or_after" title="Permalink to this definition"></a></dt>
<dd><p>The NotOnOrAfter value of the valid SubjectConfirmationData node
(if any) of the last assertion processed</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_authn_contexts">
<span class="sig-name descname"><span class="pre">get_last_authn_contexts</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_last_authn_contexts"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_authn_contexts" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The list of authentication contexts sent in the last SAML Response.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_error_reason">
<span class="sig-name descname"><span class="pre">get_last_error_reason</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_last_error_reason"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_error_reason" title="Permalink to this definition"></a></dt>
<dd><p>Returns the reason for the last error</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Reason of the last error</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>None | string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_message_id">
<span class="sig-name descname"><span class="pre">get_last_message_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_last_message_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_message_id" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The ID of the last Response SAML message processed.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_request_id">
<span class="sig-name descname"><span class="pre">get_last_request_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_last_request_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_request_id" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The ID of the last Request SAML message generated.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_request_xml">
<span class="sig-name descname"><span class="pre">get_last_request_xml</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_last_request_xml"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_request_xml" title="Permalink to this definition"></a></dt>
<dd><p>Retrieves the raw XML sent in the last SAML request
:returns: SAML request XML
:rtype: string|None</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_response_in_response_to">
<span class="sig-name descname"><span class="pre">get_last_response_in_response_to</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_last_response_in_response_to"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_response_in_response_to" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>InResponseTo attribute of the last Response SAML processed or None if it is not present.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_response_xml">
<span class="sig-name descname"><span class="pre">get_last_response_xml</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pretty_print_if_possible</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_last_response_xml"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_last_response_xml" title="Permalink to this definition"></a></dt>
<dd><p>Retrieves the raw XML (decrypted) of the last SAML response,
or the last Logout Response generated or processed
:returns: SAML response XML
:rtype: string|None</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_nameid">
<span class="sig-name descname"><span class="pre">get_nameid</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_nameid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_nameid" title="Permalink to this definition"></a></dt>
<dd><p>Returns the nameID.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>NameID</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string|None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_nameid_format">
<span class="sig-name descname"><span class="pre">get_nameid_format</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_nameid_format"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_nameid_format" title="Permalink to this definition"></a></dt>
<dd><p>Returns the nameID Format.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>NameID Format</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string|None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_nameid_nq">
<span class="sig-name descname"><span class="pre">get_nameid_nq</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_nameid_nq"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_nameid_nq" title="Permalink to this definition"></a></dt>
<dd><p>Returns the nameID NameQualifier of the Assertion.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>NameID NameQualifier</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string|None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_nameid_spnq">
<span class="sig-name descname"><span class="pre">get_nameid_spnq</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_nameid_spnq"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_nameid_spnq" title="Permalink to this definition"></a></dt>
<dd><p>Returns the nameID SP NameQualifier of the Assertion.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>NameID SP NameQualifier</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string|None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_session_expiration">
<span class="sig-name descname"><span class="pre">get_session_expiration</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_session_expiration"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_session_expiration" title="Permalink to this definition"></a></dt>
<dd><p>Returns the SessionNotOnOrAfter from the AuthnStatement.
:returns: The SessionNotOnOrAfter of the assertion
:rtype: unix/posix timestamp|None</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_session_index">
<span class="sig-name descname"><span class="pre">get_session_index</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_session_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_session_index" title="Permalink to this definition"></a></dt>
<dd><p>Returns the SessionIndex from the AuthnStatement.
:returns: The SessionIndex of the assertion
:rtype: string</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_settings">
<span class="sig-name descname"><span class="pre">get_settings</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_settings"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_settings" title="Permalink to this definition"></a></dt>
<dd><p>Returns the settings info
:return: Setting info
:rtype: OneLogin_Saml2_Setting object</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_slo_response_url">
<span class="sig-name descname"><span class="pre">get_slo_response_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_slo_response_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_slo_response_url" title="Permalink to this definition"></a></dt>
<dd><p>Gets the SLO return URL for IdP-initiated logout.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>an URL, the SLO return endpoint of the IdP</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_slo_url">
<span class="sig-name descname"><span class="pre">get_slo_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_slo_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_slo_url" title="Permalink to this definition"></a></dt>
<dd><p>Gets the SLO URL.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>An URL, the SLO endpoint of the IdP</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.get_sso_url">
<span class="sig-name descname"><span class="pre">get_sso_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.get_sso_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.get_sso_url" title="Permalink to this definition"></a></dt>
<dd><p>Gets the SSO URL.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>An URL, the SSO endpoint of the IdP</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.is_authenticated">
<span class="sig-name descname"><span class="pre">is_authenticated</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.is_authenticated"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.is_authenticated" title="Permalink to this definition"></a></dt>
<dd><p>Checks if the user is authenticated or not.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>True if is authenticated, False if not</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.login">
<span class="sig-name descname"><span class="pre">login</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">return_to</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force_authn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_passive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">set_nameid_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_id_value_req</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.login"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.login" title="Permalink to this definition"></a></dt>
<dd><p>Initiates the SSO process.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>return_to</strong> (<em>string</em>) – Optional argument. The target URL the user should be redirected to after login.</p></li>
<li><p><strong>force_authn</strong> (<em>bool</em>) – Optional argument. When true the AuthNRequest will set the ForceAuthn=’true’.</p></li>
<li><p><strong>is_passive</strong> (<em>bool</em>) – Optional argument. When true the AuthNRequest will set the Ispassive=’true’.</p></li>
<li><p><strong>set_nameid_policy</strong> (<em>bool</em>) – Optional argument. When true the AuthNRequest will set a nameIdPolicy element.</p></li>
<li><p><strong>name_id_value_req</strong> (<em>string</em>) – Optional argument. Indicates to the IdP the subject that should be authenticated</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Redirection URL</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.logout">
<span class="sig-name descname"><span class="pre">logout</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">return_to</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session_index</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nq</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_id_format</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spnq</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.logout"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.logout" title="Permalink to this definition"></a></dt>
<dd><p>Initiates the SLO process.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>return_to</strong> (<em>string</em>) – Optional argument. The target URL the user should be redirected to after logout.</p></li>
<li><p><strong>name_id</strong> (<em>string</em>) – The NameID that will be set in the LogoutRequest.</p></li>
<li><p><strong>session_index</strong> (<em>string</em>) – SessionIndex that identifies the session of the user.</p></li>
<li><p><strong>nq</strong> – IDP Name Qualifier</p></li>
<li><p><strong>name_id_format</strong> – The NameID Format that will be set in the LogoutRequest.</p></li>
<li><p><strong>spnq</strong> – SP Name Qualifier</p></li>
</ul>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Redirection URL</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.logout_request_class">
<span class="sig-name descname"><span class="pre">logout_request_class</span></span><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.logout_request_class" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="#onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request" title="onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request"><code class="xref py py-class docutils literal notranslate"><span class="pre">OneLogin_Saml2_Logout_Request</span></code></a></p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.logout_response_class">
<span class="sig-name descname"><span class="pre">logout_response_class</span></span><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.logout_response_class" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="#onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response" title="onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response"><code class="xref py py-class docutils literal notranslate"><span class="pre">OneLogin_Saml2_Logout_Response</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.process_response">
<span class="sig-name descname"><span class="pre">process_response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.process_response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.process_response" title="Permalink to this definition"></a></dt>
<dd><p>Process the SAML Response sent by the IdP.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>request_id</strong> (<em>string</em>) – Is an optional argument. Is the ID of the AuthNRequest sent by this SP to the IdP.</p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p>OneLogin_Saml2_Error.SAML_RESPONSE_NOT_FOUND, when a POST with a SAMLResponse is not found</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.process_slo">
<span class="sig-name descname"><span class="pre">process_slo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">keep_local_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">delete_session_cb</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.process_slo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.process_slo" title="Permalink to this definition"></a></dt>
<dd><p>Process the SAML Logout Response / Logout Request sent by the IdP.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>keep_local_session</strong> (<em>bool</em>) – When false will destroy the local session, otherwise will destroy it</p></li>
<li><p><strong>request_id</strong> (<em>string</em>) – The ID of the LogoutRequest sent by this SP to the IdP</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Redirection url</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.redirect_to">
<span class="sig-name descname"><span class="pre">redirect_to</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.redirect_to"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.redirect_to" title="Permalink to this definition"></a></dt>
<dd><p>Redirects the user to the URL passed by parameter or to the URL that we defined in our SSO Request.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>url</strong> (<em>string</em>) – The target URL to redirect the user</p></li>
<li><p><strong>parameters</strong> (<em>dict</em>) – Extra parameters to be passed as part of the URL</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Redirection URL</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.response_class">
<span class="sig-name descname"><span class="pre">response_class</span></span><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.response_class" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="#onelogin.saml2.response.OneLogin_Saml2_Response" title="onelogin.saml2.response.OneLogin_Saml2_Response"><code class="xref py py-class docutils literal notranslate"><span class="pre">OneLogin_Saml2_Response</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.set_strict">
<span class="sig-name descname"><span class="pre">set_strict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.set_strict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.set_strict" title="Permalink to this definition"></a></dt>
<dd><p>Set the strict mode active/disable</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>value</strong> (<em>bool</em>) – </p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.store_valid_response">
<span class="sig-name descname"><span class="pre">store_valid_response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.store_valid_response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.store_valid_response" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.validate_request_signature">
<span class="sig-name descname"><span class="pre">validate_request_signature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.validate_request_signature"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.validate_request_signature" title="Permalink to this definition"></a></dt>
<dd><p>Validate Request Signature</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>request_data</strong> (<em>dict</em>) – The Request data</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.auth.OneLogin_Saml2_Auth.validate_response_signature">
<span class="sig-name descname"><span class="pre">validate_response_signature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/auth.html#OneLogin_Saml2_Auth.validate_response_signature"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.auth.OneLogin_Saml2_Auth.validate_response_signature" title="Permalink to this definition"></a></dt>
<dd><p>Validate Response Signature</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>request_data</strong> (<em>dict</em>) – The Request data</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-onelogin.saml2.authn_request">
<span id="onelogin-saml2-authn-request-module"></span><h2>onelogin.saml2.authn_request module<a class="headerlink" href="#module-onelogin.saml2.authn_request" title="Permalink to this heading"></a></h2>
<p>OneLogin_Saml2_Authn_Request class</p>
<p>AuthNRequest class of SAML Python Toolkit.</p>
<dl class="py class">
<dt class="sig sig-object py" id="onelogin.saml2.authn_request.OneLogin_Saml2_Authn_Request">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">onelogin.saml2.authn_request.</span></span><span class="sig-name descname"><span class="pre">OneLogin_Saml2_Authn_Request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force_authn</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">is_passive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">set_nameid_policy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_id_value_req</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/authn_request.html#OneLogin_Saml2_Authn_Request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.authn_request.OneLogin_Saml2_Authn_Request" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This class handles an AuthNRequest. It builds an
AuthNRequest object.</p>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.authn_request.OneLogin_Saml2_Authn_Request.get_id">
<span class="sig-name descname"><span class="pre">get_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/authn_request.html#OneLogin_Saml2_Authn_Request.get_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.authn_request.OneLogin_Saml2_Authn_Request.get_id" title="Permalink to this definition"></a></dt>
<dd><p>Returns the AuthNRequest ID.
:return: AuthNRequest ID
:rtype: string</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.authn_request.OneLogin_Saml2_Authn_Request.get_request">
<span class="sig-name descname"><span class="pre">get_request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deflate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/authn_request.html#OneLogin_Saml2_Authn_Request.get_request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.authn_request.OneLogin_Saml2_Authn_Request.get_request" title="Permalink to this definition"></a></dt>
<dd><p>Returns unsigned AuthnRequest.
:param deflate: It makes the deflate process optional
:type: bool
:return: AuthnRequest maybe deflated and base64 encoded
:rtype: str object</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.authn_request.OneLogin_Saml2_Authn_Request.get_xml">
<span class="sig-name descname"><span class="pre">get_xml</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/authn_request.html#OneLogin_Saml2_Authn_Request.get_xml"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.authn_request.OneLogin_Saml2_Authn_Request.get_xml" title="Permalink to this definition"></a></dt>
<dd><p>Returns the XML that will be sent as part of the request
:return: XML request body
:rtype: string</p>
</dd></dl>
</dd></dl>
</section>
<section id="module-onelogin.saml2.compat">
<span id="onelogin-saml2-compat-module"></span><h2>onelogin.saml2.compat module<a class="headerlink" href="#module-onelogin.saml2.compat" title="Permalink to this heading"></a></h2>
<p>py3 compatibility class</p>
<dl class="py function">
<dt class="sig sig-object py" id="onelogin.saml2.compat.to_bytes">
<span class="sig-prename descclassname"><span class="pre">onelogin.saml2.compat.</span></span><span class="sig-name descname"><span class="pre">to_bytes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/compat.html#to_bytes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.compat.to_bytes" title="Permalink to this definition"></a></dt>
<dd><p>return bytes</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="onelogin.saml2.compat.to_string">
<span class="sig-prename descclassname"><span class="pre">onelogin.saml2.compat.</span></span><span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/compat.html#to_string"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.compat.to_string" title="Permalink to this definition"></a></dt>
<dd><p>convert to string</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="onelogin.saml2.compat.utf8">
<span class="sig-prename descclassname"><span class="pre">onelogin.saml2.compat.</span></span><span class="sig-name descname"><span class="pre">utf8</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/compat.html#utf8"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.compat.utf8" title="Permalink to this definition"></a></dt>
<dd><p>return utf8-encoded string</p>
</dd></dl>
</section>
<section id="module-onelogin.saml2.constants">
<span id="onelogin-saml2-constants-module"></span><h2>onelogin.saml2.constants module<a class="headerlink" href="#module-onelogin.saml2.constants" title="Permalink to this heading"></a></h2>
<p>OneLogin_Saml2_Constants class</p>
<p>Constants class of SAML Python Toolkit.</p>
<dl class="py class">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">onelogin.saml2.constants.</span></span><span class="sig-name descname"><span class="pre">OneLogin_Saml2_Constants</span></span><a class="reference internal" href="_modules/onelogin/saml2/constants.html#OneLogin_Saml2_Constants"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This class defines all the constants that will be used
in the SAML Python Toolkit.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.AC_KERBEROS">
<span class="sig-name descname"><span class="pre">AC_KERBEROS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:ac:classes:Kerberos'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.AC_KERBEROS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.AC_PASSWORD">
<span class="sig-name descname"><span class="pre">AC_PASSWORD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:ac:classes:Password'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.AC_PASSWORD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.AC_PASSWORD_PROTECTED">
<span class="sig-name descname"><span class="pre">AC_PASSWORD_PROTECTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.AC_PASSWORD_PROTECTED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.AC_SMARTCARD">
<span class="sig-name descname"><span class="pre">AC_SMARTCARD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:ac:classes:Smartcard'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.AC_SMARTCARD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.AC_UNSPECIFIED">
<span class="sig-name descname"><span class="pre">AC_UNSPECIFIED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:ac:classes:unspecified'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.AC_UNSPECIFIED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.AC_X509">
<span class="sig-name descname"><span class="pre">AC_X509</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:ac:classes:X509'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.AC_X509" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.AES128_CBC">
<span class="sig-name descname"><span class="pre">AES128_CBC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://www.w3.org/2001/04/xmlenc#aes128-cbc'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.AES128_CBC" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.AES192_CBC">
<span class="sig-name descname"><span class="pre">AES192_CBC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://www.w3.org/2001/04/xmlenc#aes192-cbc'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.AES192_CBC" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.AES256_CBC">
<span class="sig-name descname"><span class="pre">AES256_CBC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://www.w3.org/2001/04/xmlenc#aes256-cbc'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.AES256_CBC" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.ALLOWED_CLOCK_DRIFT">
<span class="sig-name descname"><span class="pre">ALLOWED_CLOCK_DRIFT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">300</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.ALLOWED_CLOCK_DRIFT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.ATTRNAME_FORMAT_BASIC">
<span class="sig-name descname"><span class="pre">ATTRNAME_FORMAT_BASIC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:attrname-format:basic'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.ATTRNAME_FORMAT_BASIC" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.ATTRNAME_FORMAT_UNSPECIFIED">
<span class="sig-name descname"><span class="pre">ATTRNAME_FORMAT_UNSPECIFIED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.ATTRNAME_FORMAT_UNSPECIFIED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.ATTRNAME_FORMAT_URI">
<span class="sig-name descname"><span class="pre">ATTRNAME_FORMAT_URI</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:attrname-format:uri'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.ATTRNAME_FORMAT_URI" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.BINDING_DEFLATE">
<span class="sig-name descname"><span class="pre">BINDING_DEFLATE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:bindings:URL-Encoding:DEFLATE'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.BINDING_DEFLATE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.BINDING_HTTP_ARTIFACT">
<span class="sig-name descname"><span class="pre">BINDING_HTTP_ARTIFACT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.BINDING_HTTP_ARTIFACT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.BINDING_HTTP_POST">
<span class="sig-name descname"><span class="pre">BINDING_HTTP_POST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.BINDING_HTTP_POST" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.BINDING_HTTP_REDIRECT">
<span class="sig-name descname"><span class="pre">BINDING_HTTP_REDIRECT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.BINDING_HTTP_REDIRECT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.BINDING_SOAP">
<span class="sig-name descname"><span class="pre">BINDING_SOAP</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:bindings:SOAP'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.BINDING_SOAP" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.CM_BEARER">
<span class="sig-name descname"><span class="pre">CM_BEARER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:cm:bearer'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.CM_BEARER" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.CM_HOLDER_KEY">
<span class="sig-name descname"><span class="pre">CM_HOLDER_KEY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:cm:holder-of-key'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.CM_HOLDER_KEY" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.CM_SENDER_VOUCHES">
<span class="sig-name descname"><span class="pre">CM_SENDER_VOUCHES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:cm:sender-vouches'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.CM_SENDER_VOUCHES" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.DEPRECATED_ALGORITHMS">
<span class="sig-name descname"><span class="pre">DEPRECATED_ALGORITHMS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['http://www.w3.org/2000/09/xmldsig#dsa-sha1',</span> <span class="pre">'http://www.w3.org/2000/09/xmldsig#rsa-sha1',</span> <span class="pre">'http://www.w3.org/2000/09/xmldsig#sha1']</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.DEPRECATED_ALGORITHMS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.DSA_SHA1">
<span class="sig-name descname"><span class="pre">DSA_SHA1</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://www.w3.org/2000/09/xmldsig#dsa-sha1'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.DSA_SHA1" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NAMEID_EMAIL_ADDRESS">
<span class="sig-name descname"><span class="pre">NAMEID_EMAIL_ADDRESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NAMEID_EMAIL_ADDRESS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NAMEID_ENCRYPTED">
<span class="sig-name descname"><span class="pre">NAMEID_ENCRYPTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:nameid-format:encrypted'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NAMEID_ENCRYPTED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NAMEID_ENTITY">
<span class="sig-name descname"><span class="pre">NAMEID_ENTITY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:nameid-format:entity'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NAMEID_ENTITY" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NAMEID_KERBEROS">
<span class="sig-name descname"><span class="pre">NAMEID_KERBEROS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NAMEID_KERBEROS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NAMEID_PERSISTENT">
<span class="sig-name descname"><span class="pre">NAMEID_PERSISTENT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NAMEID_PERSISTENT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NAMEID_TRANSIENT">
<span class="sig-name descname"><span class="pre">NAMEID_TRANSIENT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:nameid-format:transient'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NAMEID_TRANSIENT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NAMEID_UNSPECIFIED">
<span class="sig-name descname"><span class="pre">NAMEID_UNSPECIFIED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NAMEID_UNSPECIFIED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NAMEID_WINDOWS_DOMAIN_QUALIFIED_NAME">
<span class="sig-name descname"><span class="pre">NAMEID_WINDOWS_DOMAIN_QUALIFIED_NAME</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NAMEID_WINDOWS_DOMAIN_QUALIFIED_NAME" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NAMEID_X509_SUBJECT_NAME">
<span class="sig-name descname"><span class="pre">NAMEID_X509_SUBJECT_NAME</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NAMEID_X509_SUBJECT_NAME" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NSMAP">
<span class="sig-name descname"><span class="pre">NSMAP</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'ds':</span> <span class="pre">'http://www.w3.org/2000/09/xmldsig#',</span> <span class="pre">'md':</span> <span class="pre">'urn:oasis:names:tc:SAML:2.0:metadata',</span> <span class="pre">'saml':</span> <span class="pre">'urn:oasis:names:tc:SAML:2.0:assertion',</span> <span class="pre">'samlp':</span> <span class="pre">'urn:oasis:names:tc:SAML:2.0:protocol',</span> <span class="pre">'xenc':</span> <span class="pre">'http://www.w3.org/2001/04/xmlenc#'}</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NSMAP" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_DS">
<span class="sig-name descname"><span class="pre">NS_DS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://www.w3.org/2000/09/xmldsig#'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_DS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_MD">
<span class="sig-name descname"><span class="pre">NS_MD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:metadata'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_MD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_PREFIX_DS">
<span class="sig-name descname"><span class="pre">NS_PREFIX_DS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ds'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_PREFIX_DS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_PREFIX_MD">
<span class="sig-name descname"><span class="pre">NS_PREFIX_MD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'md'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_PREFIX_MD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_PREFIX_SAML">
<span class="sig-name descname"><span class="pre">NS_PREFIX_SAML</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'saml'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_PREFIX_SAML" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_PREFIX_SAMLP">
<span class="sig-name descname"><span class="pre">NS_PREFIX_SAMLP</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'samlp'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_PREFIX_SAMLP" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_PREFIX_XENC">
<span class="sig-name descname"><span class="pre">NS_PREFIX_XENC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'xenc'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_PREFIX_XENC" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_PREFIX_XS">
<span class="sig-name descname"><span class="pre">NS_PREFIX_XS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'xs'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_PREFIX_XS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_PREFIX_XSD">
<span class="sig-name descname"><span class="pre">NS_PREFIX_XSD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'xsd'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_PREFIX_XSD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_PREFIX_XSI">
<span class="sig-name descname"><span class="pre">NS_PREFIX_XSI</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'xsi'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_PREFIX_XSI" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_SAML">
<span class="sig-name descname"><span class="pre">NS_SAML</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:assertion'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_SAML" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_SAMLP">
<span class="sig-name descname"><span class="pre">NS_SAMLP</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:protocol'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_SAMLP" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_SOAP">
<span class="sig-name descname"><span class="pre">NS_SOAP</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://schemas.xmlsoap.org/soap/envelope/'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_SOAP" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_XENC">
<span class="sig-name descname"><span class="pre">NS_XENC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://www.w3.org/2001/04/xmlenc#'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_XENC" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_XS">
<span class="sig-name descname"><span class="pre">NS_XS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://www.w3.org/2001/XMLSchema'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_XS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_XSI">
<span class="sig-name descname"><span class="pre">NS_XSI</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://www.w3.org/2001/XMLSchema-instance'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.NS_XSI" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.RSA_1_5">
<span class="sig-name descname"><span class="pre">RSA_1_5</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://www.w3.org/2001/04/xmlenc#rsa-1_5'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.RSA_1_5" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.RSA_OAEP_MGF1P">
<span class="sig-name descname"><span class="pre">RSA_OAEP_MGF1P</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.RSA_OAEP_MGF1P" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.RSA_SHA1">
<span class="sig-name descname"><span class="pre">RSA_SHA1</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://www.w3.org/2000/09/xmldsig#rsa-sha1'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.RSA_SHA1" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.RSA_SHA256">
<span class="sig-name descname"><span class="pre">RSA_SHA256</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://www.w3.org/2001/04/xmldsig-more#rsa-sha256'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.RSA_SHA256" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.RSA_SHA384">
<span class="sig-name descname"><span class="pre">RSA_SHA384</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://www.w3.org/2001/04/xmldsig-more#rsa-sha384'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.RSA_SHA384" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.RSA_SHA512">
<span class="sig-name descname"><span class="pre">RSA_SHA512</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://www.w3.org/2001/04/xmldsig-more#rsa-sha512'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.RSA_SHA512" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.SHA1">
<span class="sig-name descname"><span class="pre">SHA1</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://www.w3.org/2000/09/xmldsig#sha1'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.SHA1" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.SHA256">
<span class="sig-name descname"><span class="pre">SHA256</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://www.w3.org/2001/04/xmlenc#sha256'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.SHA256" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.SHA384">
<span class="sig-name descname"><span class="pre">SHA384</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://www.w3.org/2001/04/xmldsig-more#sha384'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.SHA384" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.SHA512">
<span class="sig-name descname"><span class="pre">SHA512</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://www.w3.org/2001/04/xmlenc#sha512'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.SHA512" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.STATUS_NO_PASSIVE">
<span class="sig-name descname"><span class="pre">STATUS_NO_PASSIVE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:status:NoPassive'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.STATUS_NO_PASSIVE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.STATUS_PARTIAL_LOGOUT">
<span class="sig-name descname"><span class="pre">STATUS_PARTIAL_LOGOUT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:status:PartialLogout'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.STATUS_PARTIAL_LOGOUT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.STATUS_PROXY_COUNT_EXCEEDED">
<span class="sig-name descname"><span class="pre">STATUS_PROXY_COUNT_EXCEEDED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:status:ProxyCountExceeded'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.STATUS_PROXY_COUNT_EXCEEDED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.STATUS_REQUESTER">
<span class="sig-name descname"><span class="pre">STATUS_REQUESTER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:status:Requester'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.STATUS_REQUESTER" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.STATUS_RESPONDER">
<span class="sig-name descname"><span class="pre">STATUS_RESPONDER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:status:Responder'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.STATUS_RESPONDER" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.STATUS_SUCCESS">
<span class="sig-name descname"><span class="pre">STATUS_SUCCESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:status:Success'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.STATUS_SUCCESS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.STATUS_VERSION_MISMATCH">
<span class="sig-name descname"><span class="pre">STATUS_VERSION_MISMATCH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'urn:oasis:names:tc:SAML:2.0:status:VersionMismatch'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.STATUS_VERSION_MISMATCH" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.constants.OneLogin_Saml2_Constants.TRIPLEDES_CBC">
<span class="sig-name descname"><span class="pre">TRIPLEDES_CBC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'http://www.w3.org/2001/04/xmlenc#tripledes-cbc'</span></em><a class="headerlink" href="#onelogin.saml2.constants.OneLogin_Saml2_Constants.TRIPLEDES_CBC" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-onelogin.saml2.errors">
<span id="onelogin-saml2-errors-module"></span><h2>onelogin.saml2.errors module<a class="headerlink" href="#module-onelogin.saml2.errors" title="Permalink to this heading"></a></h2>
<p>OneLogin_Saml2_Error class</p>
<p>Error class of SAML Python Toolkit.</p>
<p>Defines common Error codes and has a custom initializator.</p>
<dl class="py exception">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_Error">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">onelogin.saml2.errors.</span></span><span class="sig-name descname"><span class="pre">OneLogin_Saml2_Error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">code</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/errors.html#OneLogin_Saml2_Error"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_Error" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
<p>This class implements a custom Exception handler.
Defines custom error codes.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_Error.CERT_NOT_FOUND">
<span class="sig-name descname"><span class="pre">CERT_NOT_FOUND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_Error.CERT_NOT_FOUND" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_Error.METADATA_SP_INVALID">
<span class="sig-name descname"><span class="pre">METADATA_SP_INVALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_Error.METADATA_SP_INVALID" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_Error.PRIVATE_KEY_FILE_NOT_FOUND">
<span class="sig-name descname"><span class="pre">PRIVATE_KEY_FILE_NOT_FOUND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">7</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_Error.PRIVATE_KEY_FILE_NOT_FOUND" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_Error.PRIVATE_KEY_NOT_FOUND">
<span class="sig-name descname"><span class="pre">PRIVATE_KEY_NOT_FOUND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">13</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_Error.PRIVATE_KEY_NOT_FOUND" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_Error.PUBLIC_CERT_FILE_NOT_FOUND">
<span class="sig-name descname"><span class="pre">PUBLIC_CERT_FILE_NOT_FOUND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">6</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_Error.PUBLIC_CERT_FILE_NOT_FOUND" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_Error.REDIRECT_INVALID_URL">
<span class="sig-name descname"><span class="pre">REDIRECT_INVALID_URL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_Error.REDIRECT_INVALID_URL" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_Error.SAML_LOGOUTMESSAGE_NOT_FOUND">
<span class="sig-name descname"><span class="pre">SAML_LOGOUTMESSAGE_NOT_FOUND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">9</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_Error.SAML_LOGOUTMESSAGE_NOT_FOUND" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_Error.SAML_LOGOUTREQUEST_INVALID">
<span class="sig-name descname"><span class="pre">SAML_LOGOUTREQUEST_INVALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_Error.SAML_LOGOUTREQUEST_INVALID" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_Error.SAML_LOGOUTRESPONSE_INVALID">
<span class="sig-name descname"><span class="pre">SAML_LOGOUTRESPONSE_INVALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">11</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_Error.SAML_LOGOUTRESPONSE_INVALID" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_Error.SAML_RESPONSE_NOT_FOUND">
<span class="sig-name descname"><span class="pre">SAML_RESPONSE_NOT_FOUND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">8</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_Error.SAML_RESPONSE_NOT_FOUND" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_Error.SAML_SINGLE_LOGOUT_NOT_SUPPORTED">
<span class="sig-name descname"><span class="pre">SAML_SINGLE_LOGOUT_NOT_SUPPORTED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">12</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_Error.SAML_SINGLE_LOGOUT_NOT_SUPPORTED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_Error.SETTINGS_FILE_NOT_FOUND">
<span class="sig-name descname"><span class="pre">SETTINGS_FILE_NOT_FOUND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_Error.SETTINGS_FILE_NOT_FOUND" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_Error.SETTINGS_INVALID">
<span class="sig-name descname"><span class="pre">SETTINGS_INVALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_Error.SETTINGS_INVALID" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_Error.SETTINGS_INVALID_SYNTAX">
<span class="sig-name descname"><span class="pre">SETTINGS_INVALID_SYNTAX</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_Error.SETTINGS_INVALID_SYNTAX" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_Error.SP_CERTS_NOT_FOUND">
<span class="sig-name descname"><span class="pre">SP_CERTS_NOT_FOUND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_Error.SP_CERTS_NOT_FOUND" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_Error.UNSUPPORTED_SETTINGS_OBJECT">
<span class="sig-name descname"><span class="pre">UNSUPPORTED_SETTINGS_OBJECT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">14</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_Error.UNSUPPORTED_SETTINGS_OBJECT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">onelogin.saml2.errors.</span></span><span class="sig-name descname"><span class="pre">OneLogin_Saml2_ValidationError</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">message</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">code</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/errors.html#OneLogin_Saml2_ValidationError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
<p>This class implements another custom Exception handler, related
to exceptions that happens during validation process.
Defines custom error codes .</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.ASSERTION_EXPIRED">
<span class="sig-name descname"><span class="pre">ASSERTION_EXPIRED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">20</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.ASSERTION_EXPIRED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.ASSERTION_TOO_EARLY">
<span class="sig-name descname"><span class="pre">ASSERTION_TOO_EARLY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">19</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.ASSERTION_TOO_EARLY" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.AUTHN_CONTEXT_MISMATCH">
<span class="sig-name descname"><span class="pre">AUTHN_CONTEXT_MISMATCH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">45</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.AUTHN_CONTEXT_MISMATCH" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.CHILDREN_NODE_NOT_FOUND_IN_KEYINFO">
<span class="sig-name descname"><span class="pre">CHILDREN_NODE_NOT_FOUND_IN_KEYINFO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">36</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.CHILDREN_NODE_NOT_FOUND_IN_KEYINFO" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.DEPRECATED_DIGEST_METHOD">
<span class="sig-name descname"><span class="pre">DEPRECATED_DIGEST_METHOD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">47</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.DEPRECATED_DIGEST_METHOD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.DEPRECATED_SIGNATURE_METHOD">
<span class="sig-name descname"><span class="pre">DEPRECATED_SIGNATURE_METHOD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">46</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.DEPRECATED_SIGNATURE_METHOD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.DUPLICATED_ATTRIBUTE_NAME_FOUND">
<span class="sig-name descname"><span class="pre">DUPLICATED_ATTRIBUTE_NAME_FOUND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">41</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.DUPLICATED_ATTRIBUTE_NAME_FOUND" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.DUPLICATED_ID_IN_SIGNED_ELEMENTS">
<span class="sig-name descname"><span class="pre">DUPLICATED_ID_IN_SIGNED_ELEMENTS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">8</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.DUPLICATED_ID_IN_SIGNED_ELEMENTS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.DUPLICATED_REFERENCE_IN_SIGNED_ELEMENTS">
<span class="sig-name descname"><span class="pre">DUPLICATED_REFERENCE_IN_SIGNED_ELEMENTS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">10</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.DUPLICATED_REFERENCE_IN_SIGNED_ELEMENTS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.EMPTY_DESTINATION">
<span class="sig-name descname"><span class="pre">EMPTY_DESTINATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">25</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.EMPTY_DESTINATION" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.EMPTY_NAMEID">
<span class="sig-name descname"><span class="pre">EMPTY_NAMEID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">39</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.EMPTY_NAMEID" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.ENCRYPTED_ATTRIBUTES">
<span class="sig-name descname"><span class="pre">ENCRYPTED_ATTRIBUTES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">23</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.ENCRYPTED_ATTRIBUTES" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.ID_NOT_FOUND_IN_SIGNED_ELEMENT">
<span class="sig-name descname"><span class="pre">ID_NOT_FOUND_IN_SIGNED_ELEMENT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">7</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.ID_NOT_FOUND_IN_SIGNED_ELEMENT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.INVALID_SIGNATURE">
<span class="sig-name descname"><span class="pre">INVALID_SIGNATURE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">42</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.INVALID_SIGNATURE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.INVALID_SIGNED_ELEMENT">
<span class="sig-name descname"><span class="pre">INVALID_SIGNED_ELEMENT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">9</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.INVALID_SIGNED_ELEMENT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.INVALID_XML_FORMAT">
<span class="sig-name descname"><span class="pre">INVALID_XML_FORMAT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">14</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.INVALID_XML_FORMAT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.ISSUER_MULTIPLE_IN_RESPONSE">
<span class="sig-name descname"><span class="pre">ISSUER_MULTIPLE_IN_RESPONSE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">27</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.ISSUER_MULTIPLE_IN_RESPONSE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.ISSUER_NOT_FOUND_IN_ASSERTION">
<span class="sig-name descname"><span class="pre">ISSUER_NOT_FOUND_IN_ASSERTION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">28</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.ISSUER_NOT_FOUND_IN_ASSERTION" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.KEYINFO_NOT_FOUND_IN_ENCRYPTED_DATA">
<span class="sig-name descname"><span class="pre">KEYINFO_NOT_FOUND_IN_ENCRYPTED_DATA</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">35</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.KEYINFO_NOT_FOUND_IN_ENCRYPTED_DATA" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.MISSING_CONDITIONS">
<span class="sig-name descname"><span class="pre">MISSING_CONDITIONS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">18</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.MISSING_CONDITIONS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.MISSING_ID">
<span class="sig-name descname"><span class="pre">MISSING_ID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.MISSING_ID" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.MISSING_STATUS">
<span class="sig-name descname"><span class="pre">MISSING_STATUS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.MISSING_STATUS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.MISSING_STATUS_CODE">
<span class="sig-name descname"><span class="pre">MISSING_STATUS_CODE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.MISSING_STATUS_CODE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.NO_ATTRIBUTESTATEMENT">
<span class="sig-name descname"><span class="pre">NO_ATTRIBUTESTATEMENT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">22</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.NO_ATTRIBUTESTATEMENT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.NO_ENCRYPTED_ASSERTION">
<span class="sig-name descname"><span class="pre">NO_ENCRYPTED_ASSERTION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">16</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.NO_ENCRYPTED_ASSERTION" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.NO_ENCRYPTED_NAMEID">
<span class="sig-name descname"><span class="pre">NO_ENCRYPTED_NAMEID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">17</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.NO_ENCRYPTED_NAMEID" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.NO_NAMEID">
<span class="sig-name descname"><span class="pre">NO_NAMEID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">38</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.NO_NAMEID" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.NO_SIGNATURE_FOUND">
<span class="sig-name descname"><span class="pre">NO_SIGNATURE_FOUND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">34</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.NO_SIGNATURE_FOUND" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.NO_SIGNED_ASSERTION">
<span class="sig-name descname"><span class="pre">NO_SIGNED_ASSERTION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">33</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.NO_SIGNED_ASSERTION" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.NO_SIGNED_MESSAGE">
<span class="sig-name descname"><span class="pre">NO_SIGNED_MESSAGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">32</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.NO_SIGNED_MESSAGE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.RESPONSE_EXPIRED">
<span class="sig-name descname"><span class="pre">RESPONSE_EXPIRED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">44</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.RESPONSE_EXPIRED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.SESSION_EXPIRED">
<span class="sig-name descname"><span class="pre">SESSION_EXPIRED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">30</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.SESSION_EXPIRED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.SP_NAME_QUALIFIER_NAME_MISMATCH">
<span class="sig-name descname"><span class="pre">SP_NAME_QUALIFIER_NAME_MISMATCH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">40</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.SP_NAME_QUALIFIER_NAME_MISMATCH" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.STATUS_CODE_IS_NOT_SUCCESS">
<span class="sig-name descname"><span class="pre">STATUS_CODE_IS_NOT_SUCCESS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">5</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.STATUS_CODE_IS_NOT_SUCCESS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.UNEXPECTED_SIGNED_ELEMENTS">
<span class="sig-name descname"><span class="pre">UNEXPECTED_SIGNED_ELEMENTS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">11</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.UNEXPECTED_SIGNED_ELEMENTS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.UNSUPPORTED_RETRIEVAL_METHOD">
<span class="sig-name descname"><span class="pre">UNSUPPORTED_RETRIEVAL_METHOD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">37</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.UNSUPPORTED_RETRIEVAL_METHOD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.UNSUPPORTED_SAML_VERSION">
<span class="sig-name descname"><span class="pre">UNSUPPORTED_SAML_VERSION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.UNSUPPORTED_SAML_VERSION" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_AUDIENCE">
<span class="sig-name descname"><span class="pre">WRONG_AUDIENCE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">26</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_AUDIENCE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_DESTINATION">
<span class="sig-name descname"><span class="pre">WRONG_DESTINATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">24</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_DESTINATION" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_INRESPONSETO">
<span class="sig-name descname"><span class="pre">WRONG_INRESPONSETO</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">15</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_INRESPONSETO" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_ISSUER">
<span class="sig-name descname"><span class="pre">WRONG_ISSUER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">29</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_ISSUER" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_NUMBER_OF_ASSERTIONS">
<span class="sig-name descname"><span class="pre">WRONG_NUMBER_OF_ASSERTIONS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_NUMBER_OF_ASSERTIONS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_NUMBER_OF_AUTHSTATEMENTS">
<span class="sig-name descname"><span class="pre">WRONG_NUMBER_OF_AUTHSTATEMENTS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">21</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_NUMBER_OF_AUTHSTATEMENTS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_NUMBER_OF_SIGNATURES">
<span class="sig-name descname"><span class="pre">WRONG_NUMBER_OF_SIGNATURES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">43</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_NUMBER_OF_SIGNATURES" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_NUMBER_OF_SIGNATURES_IN_ASSERTION">
<span class="sig-name descname"><span class="pre">WRONG_NUMBER_OF_SIGNATURES_IN_ASSERTION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">13</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_NUMBER_OF_SIGNATURES_IN_ASSERTION" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_NUMBER_OF_SIGNATURES_IN_RESPONSE">
<span class="sig-name descname"><span class="pre">WRONG_NUMBER_OF_SIGNATURES_IN_RESPONSE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">12</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_NUMBER_OF_SIGNATURES_IN_RESPONSE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_SIGNED_ELEMENT">
<span class="sig-name descname"><span class="pre">WRONG_SIGNED_ELEMENT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">6</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_SIGNED_ELEMENT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_SUBJECTCONFIRMATION">
<span class="sig-name descname"><span class="pre">WRONG_SUBJECTCONFIRMATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">31</span></em><a class="headerlink" href="#onelogin.saml2.errors.OneLogin_Saml2_ValidationError.WRONG_SUBJECTCONFIRMATION" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-onelogin.saml2.idp_metadata_parser">
<span id="onelogin-saml2-idp-metadata-parser-module"></span><h2>onelogin.saml2.idp_metadata_parser module<a class="headerlink" href="#module-onelogin.saml2.idp_metadata_parser" title="Permalink to this heading"></a></h2>
<p>OneLogin_Saml2_IdPMetadataParser class
Metadata class of SAML Python Toolkit.</p>
<dl class="py class">
<dt class="sig sig-object py" id="onelogin.saml2.idp_metadata_parser.OneLogin_Saml2_IdPMetadataParser">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">onelogin.saml2.idp_metadata_parser.</span></span><span class="sig-name descname"><span class="pre">OneLogin_Saml2_IdPMetadataParser</span></span><a class="reference internal" href="_modules/onelogin/saml2/idp_metadata_parser.html#OneLogin_Saml2_IdPMetadataParser"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.idp_metadata_parser.OneLogin_Saml2_IdPMetadataParser" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>A class that contain methods related to obtaining and parsing metadata from IdP</p>
<p>This class does not validate in any way the URL that is introduced,
make sure to validate it properly before use it in a get_metadata method.</p>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.idp_metadata_parser.OneLogin_Saml2_IdPMetadataParser.get_metadata">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_metadata</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validate_cert</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/idp_metadata_parser.html#OneLogin_Saml2_IdPMetadataParser.get_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.idp_metadata_parser.OneLogin_Saml2_IdPMetadataParser.get_metadata" title="Permalink to this definition"></a></dt>
<dd><p>Gets the metadata XML from the provided URL
:param url: Url where the XML of the Identity Provider Metadata is published.
:type url: string</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>validate_cert</strong> (<em>bool</em>) – If the url uses https schema, that flag enables or not the verification of the associated certificate.</p></li>
<li><p><strong>timeout</strong> (<em>int</em>) – Timeout in seconds to wait for metadata response</p></li>
<li><p><strong>headers</strong> (<em>dict</em>) – Extra headers to send in the request</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>metadata XML</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.idp_metadata_parser.OneLogin_Saml2_IdPMetadataParser.merge_settings">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">merge_settings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new_metadata_settings</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/idp_metadata_parser.html#OneLogin_Saml2_IdPMetadataParser.merge_settings"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.idp_metadata_parser.OneLogin_Saml2_IdPMetadataParser.merge_settings" title="Permalink to this definition"></a></dt>
<dd><p>Will update the settings with the provided new settings data extracted from the IdP metadata
:param settings: Current settings dict data
:type settings: dict
:param new_metadata_settings: Settings to be merged (extracted from IdP metadata after parsing)
:type new_metadata_settings: dict
:returns: merged settings
:rtype: dict</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.idp_metadata_parser.OneLogin_Saml2_IdPMetadataParser.parse">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">idp_metadata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">required_sso_binding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">required_slo_binding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entity_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/idp_metadata_parser.html#OneLogin_Saml2_IdPMetadataParser.parse"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.idp_metadata_parser.OneLogin_Saml2_IdPMetadataParser.parse" title="Permalink to this definition"></a></dt>
<dd><p>Parses the Identity Provider metadata and return a dict with extracted data.</p>
<p>If there are multiple <IDPSSODescriptor> tags, parse only the first.</p>
<p>Parses only those SSO endpoints with the same binding as given by
the <cite>required_sso_binding</cite> parameter.</p>
<p>Parses only those SLO endpoints with the same binding as given by
the <cite>required_slo_binding</cite> parameter.</p>
<p>If the metadata specifies multiple SSO endpoints with the required
binding, extract only the first (the same holds true for SLO
endpoints).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>idp_metadata</strong> (<em>string</em>) – XML of the Identity Provider Metadata.</p></li>
<li><p><strong>required_sso_binding</strong> (<em>one</em><em> of </em><em>OneLogin_Saml2_Constants.BINDING_HTTP_REDIRECT</em><em>
or </em><em>OneLogin_Saml2_Constants.BINDING_HTTP_POST</em>) – Parse only POST or REDIRECT SSO endpoints.</p></li>
<li><p><strong>required_slo_binding</strong> (<em>one</em><em> of </em><em>OneLogin_Saml2_Constants.BINDING_HTTP_REDIRECT</em><em>
or </em><em>OneLogin_Saml2_Constants.BINDING_HTTP_POST</em>) – Parse only POST or REDIRECT SLO endpoints.</p></li>
<li><p><strong>entity_id</strong> (<em>string</em>) – Specify the entity_id of the EntityDescriptor that you want to parse a XML
that contains multiple EntityDescriptor.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>settings dict with extracted data</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>dict</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.idp_metadata_parser.OneLogin_Saml2_IdPMetadataParser.parse_remote">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_remote</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validate_cert</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">entity_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/idp_metadata_parser.html#OneLogin_Saml2_IdPMetadataParser.parse_remote"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.idp_metadata_parser.OneLogin_Saml2_IdPMetadataParser.parse_remote" title="Permalink to this definition"></a></dt>
<dd><p>Gets the metadata XML from the provided URL and parse it, returning a dict with extracted data
:param url: Url where the XML of the Identity Provider Metadata is published.
:type url: string</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>validate_cert</strong> (<em>bool</em>) – If the url uses https schema, that flag enables or not the verification of the associated certificate.</p></li>
<li><p><strong>entity_id</strong> (<em>string</em>) – Specify the entity_id of the EntityDescriptor that you want to parse a XML
that contains multiple EntityDescriptor.</p></li>
<li><p><strong>timeout</strong> (<em>int</em>) – Timeout in seconds to wait for metadata response</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>settings dict with extracted data</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>dict</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="onelogin.saml2.idp_metadata_parser.dict_deep_merge">
<span class="sig-prename descclassname"><span class="pre">onelogin.saml2.idp_metadata_parser.</span></span><span class="sig-name descname"><span class="pre">dict_deep_merge</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">a</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">b</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/idp_metadata_parser.html#dict_deep_merge"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.idp_metadata_parser.dict_deep_merge" title="Permalink to this definition"></a></dt>
<dd><p>Deep-merge dictionary <cite>b</cite> into dictionary <cite>a</cite>.</p>
<p>Kudos to <a class="reference external" href="http://stackoverflow.com/a/7205107/145400">http://stackoverflow.com/a/7205107/145400</a></p>
</dd></dl>
</section>
<section id="module-onelogin.saml2.logout_request">
<span id="onelogin-saml2-logout-request-module"></span><h2>onelogin.saml2.logout_request module<a class="headerlink" href="#module-onelogin.saml2.logout_request" title="Permalink to this heading"></a></h2>
<p>OneLogin_Saml2_Logout_Request class</p>
<p>Logout Request class of SAML Python Toolkit.</p>
<dl class="py class">
<dt class="sig sig-object py" id="onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">onelogin.saml2.logout_request.</span></span><span class="sig-name descname"><span class="pre">OneLogin_Saml2_Logout_Request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">session_index</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nq</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_id_format</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">spnq</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_request.html#OneLogin_Saml2_Logout_Request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This class handles a Logout Request.</p>
<p>Builds a Logout Response object and validates it.</p>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.get_error">
<span class="sig-name descname"><span class="pre">get_error</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.get_error"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.get_error" title="Permalink to this definition"></a></dt>
<dd><p>After executing a validation process, if it fails this method returns the cause</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.get_id">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.get_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.get_id" title="Permalink to this definition"></a></dt>
<dd><p>Returns the ID of the Logout Request
:param request: Logout Request Message
:type request: string|DOMDocument
:return: string ID
:rtype: str object</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.get_issuer">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_issuer</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.get_issuer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.get_issuer" title="Permalink to this definition"></a></dt>
<dd><p>Gets the Issuer of the Logout Request Message
:param request: Logout Request Message
:type request: string|DOMDocument
:return: The Issuer
:rtype: string</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.get_nameid">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_nameid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.get_nameid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.get_nameid" title="Permalink to this definition"></a></dt>
<dd><p>Gets the NameID of the Logout Request Message
:param request: Logout Request Message
:type request: string|DOMDocument
:param key: The SP key
:type key: string
:return: Name ID Value
:rtype: string</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.get_nameid_data">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_nameid_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.get_nameid_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.get_nameid_data" title="Permalink to this definition"></a></dt>
<dd><p>Gets the NameID Data of the the Logout Request
:param request: Logout Request Message
:type request: string|DOMDocument
:param key: The SP key
:type key: string
:return: Name ID Data (Value, Format, NameQualifier, SPNameQualifier)
:rtype: dict</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.get_nameid_format">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_nameid_format</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.get_nameid_format"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.get_nameid_format" title="Permalink to this definition"></a></dt>
<dd><p>Gets the NameID Format of the Logout Request Message
:param request: Logout Request Message
:type request: string|DOMDocument
:param key: The SP key
:type key: string
:return: Name ID Format
:rtype: string</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.get_request">
<span class="sig-name descname"><span class="pre">get_request</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deflate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.get_request"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.get_request" title="Permalink to this definition"></a></dt>
<dd><p>Returns the Logout Request deflated, base64encoded
:param deflate: It makes the deflate process optional
:type: bool
:return: Logout Request maybe deflated and base64 encoded
:rtype: str object</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.get_session_indexes">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_session_indexes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.get_session_indexes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.get_session_indexes" title="Permalink to this definition"></a></dt>
<dd><p>Gets the SessionIndexes from the Logout Request
:param request: Logout Request Message
:type request: string|DOMDocument
:return: The SessionIndex value
:rtype: list</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.get_xml">
<span class="sig-name descname"><span class="pre">get_xml</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.get_xml"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.get_xml" title="Permalink to this definition"></a></dt>
<dd><p>Returns the XML that will be sent as part of the request
or that was received at the SP
:return: XML request body
:rtype: string</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.is_valid">
<span class="sig-name descname"><span class="pre">is_valid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_exceptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.is_valid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_request.OneLogin_Saml2_Logout_Request.is_valid" title="Permalink to this definition"></a></dt>
<dd><p>Checks if the Logout Request received is valid
:param request_data: Request Data
:type request_data: dict</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>raise_exceptions</strong> (<em>Boolean</em>) – Whether to return false on failure or raise an exception</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>If the Logout Request is or not valid</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-onelogin.saml2.logout_response">
<span id="onelogin-saml2-logout-response-module"></span><h2>onelogin.saml2.logout_response module<a class="headerlink" href="#module-onelogin.saml2.logout_response" title="Permalink to this heading"></a></h2>
<p>OneLogin_Saml2_Logout_Response class</p>
<p>Logout Response class of SAML Python Toolkit.</p>
<dl class="py class">
<dt class="sig sig-object py" id="onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">onelogin.saml2.logout_response.</span></span><span class="sig-name descname"><span class="pre">OneLogin_Saml2_Logout_Response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_response.html#OneLogin_Saml2_Logout_Response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This class handles a Logout Response. It Builds or parses a Logout Response object
and validates it.</p>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response.build">
<span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">in_response_to</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">status</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'urn:oasis:names:tc:SAML:2.0:status:Success'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_response.html#OneLogin_Saml2_Logout_Response.build"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response.build" title="Permalink to this definition"></a></dt>
<dd><p>Creates a Logout Response object.
:param in_response_to: InResponseTo value for the Logout Response.
:type in_response_to: string
:param: status: The status of the response
:type: status: string</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response.get_error">
<span class="sig-name descname"><span class="pre">get_error</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_response.html#OneLogin_Saml2_Logout_Response.get_error"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response.get_error" title="Permalink to this definition"></a></dt>
<dd><p>After executing a validation process, if it fails this method returns the cause</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response.get_in_response_to">
<span class="sig-name descname"><span class="pre">get_in_response_to</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_response.html#OneLogin_Saml2_Logout_Response.get_in_response_to"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response.get_in_response_to" title="Permalink to this definition"></a></dt>
<dd><p>Gets the ID of the LogoutRequest which this response is in response to
:returns: ID of LogoutRequest this LogoutResponse is in response to or None if it is not present
:rtype: str</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response.get_issuer">
<span class="sig-name descname"><span class="pre">get_issuer</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_response.html#OneLogin_Saml2_Logout_Response.get_issuer"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response.get_issuer" title="Permalink to this definition"></a></dt>
<dd><p>Gets the Issuer of the Logout Response Message
:return: The Issuer
:rtype: string</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response.get_response">
<span class="sig-name descname"><span class="pre">get_response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deflate</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_response.html#OneLogin_Saml2_Logout_Response.get_response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response.get_response" title="Permalink to this definition"></a></dt>
<dd><p>Returns a Logout Response object.
:param deflate: It makes the deflate process optional
:type: bool
:return: Logout Response maybe deflated and base64 encoded
:rtype: string</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response.get_status">
<span class="sig-name descname"><span class="pre">get_status</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_response.html#OneLogin_Saml2_Logout_Response.get_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response.get_status" title="Permalink to this definition"></a></dt>
<dd><p>Gets the Status
:return: The Status
:rtype: string</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response.get_xml">
<span class="sig-name descname"><span class="pre">get_xml</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_response.html#OneLogin_Saml2_Logout_Response.get_xml"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response.get_xml" title="Permalink to this definition"></a></dt>
<dd><p>Returns the XML that will be sent as part of the response
or that was received at the SP
:return: XML response body
:rtype: string</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response.is_valid">
<span class="sig-name descname"><span class="pre">is_valid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_exceptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/logout_response.html#OneLogin_Saml2_Logout_Response.is_valid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.logout_response.OneLogin_Saml2_Logout_Response.is_valid" title="Permalink to this definition"></a></dt>
<dd><p>Determines if the SAML LogoutResponse is valid
:param request_id: The ID of the LogoutRequest sent by this SP to the IdP
:type request_id: string</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>raise_exceptions</strong> (<em>Boolean</em>) – Whether to return false on failure or raise an exception</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Returns if the SAML LogoutResponse is or not valid</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>boolean</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-onelogin.saml2.metadata">
<span id="onelogin-saml2-metadata-module"></span><h2>onelogin.saml2.metadata module<a class="headerlink" href="#module-onelogin.saml2.metadata" title="Permalink to this heading"></a></h2>
<p>OneLoginSaml2Metadata class</p>
<p>Metadata class of SAML Python Toolkit.</p>
<dl class="py class">
<dt class="sig sig-object py" id="onelogin.saml2.metadata.OneLogin_Saml2_Metadata">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">onelogin.saml2.metadata.</span></span><span class="sig-name descname"><span class="pre">OneLogin_Saml2_Metadata</span></span><a class="reference internal" href="_modules/onelogin/saml2/metadata.html#OneLogin_Saml2_Metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.metadata.OneLogin_Saml2_Metadata" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>A class that contains methods related to the metadata of the SP</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.metadata.OneLogin_Saml2_Metadata.TIME_CACHED">
<span class="sig-name descname"><span class="pre">TIME_CACHED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">604800</span></em><a class="headerlink" href="#onelogin.saml2.metadata.OneLogin_Saml2_Metadata.TIME_CACHED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.metadata.OneLogin_Saml2_Metadata.TIME_VALID">
<span class="sig-name descname"><span class="pre">TIME_VALID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">172800</span></em><a class="headerlink" href="#onelogin.saml2.metadata.OneLogin_Saml2_Metadata.TIME_VALID" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.metadata.OneLogin_Saml2_Metadata.add_x509_key_descriptors">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_x509_key_descriptors</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metadata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cert</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">add_encryption</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/metadata.html#OneLogin_Saml2_Metadata.add_x509_key_descriptors"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.metadata.OneLogin_Saml2_Metadata.add_x509_key_descriptors" title="Permalink to this definition"></a></dt>
<dd><p>Adds the x509 descriptors (sign/encryption) to the metadata
The same cert will be used for sign/encrypt</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>metadata</strong> (<em>string</em>) – SAML Metadata XML</p></li>
<li><p><strong>cert</strong> (<em>string</em>) – x509 cert</p></li>
<li><p><strong>add_encryption</strong> (<em>boolean</em>) – Determines if the KeyDescriptor[use=”encryption”] should be added.</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Metadata with KeyDescriptors</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.metadata.OneLogin_Saml2_Metadata.builder">
<em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">builder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sp</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">authnsign</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wsign</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">valid_until</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cache_duration</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">contacts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">organization</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/metadata.html#OneLogin_Saml2_Metadata.builder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.metadata.OneLogin_Saml2_Metadata.builder" title="Permalink to this definition"></a></dt>
<dd><p>Builds the metadata of the SP</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>sp</strong> (<em>string</em>) – The SP data</p></li>
<li><p><strong>authnsign</strong> (<em>string</em>) – authnRequestsSigned attribute</p></li>
<li><p><strong>wsign</strong> (<em>string</em>) – wantAssertionsSigned attribute</p></li>
<li><p><strong>valid_until</strong> (<em>string</em><em>|</em><em>DateTime</em><em>|</em><em>Timestamp</em>) – Metadata’s expiry date</p></li>
<li><p><strong>cache_duration</strong> (<em>int</em><em>|</em><em>string</em>) – Duration of the cache in seconds</p></li>
<li><p><strong>contacts</strong> (<em>dict</em>) – Contacts info</p></li>
<li><p><strong>organization</strong> (<em>dict</em>) – Organization info</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.metadata.OneLogin_Saml2_Metadata.sign_metadata">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sign_metadata</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">metadata</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cert</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sign_algorithm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'http://www.w3.org/2001/04/xmldsig-more#rsa-sha256'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">digest_algorithm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'http://www.w3.org/2001/04/xmlenc#sha256'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/metadata.html#OneLogin_Saml2_Metadata.sign_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.metadata.OneLogin_Saml2_Metadata.sign_metadata" title="Permalink to this definition"></a></dt>
<dd><p>Signs the metadata with the key/cert provided</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>metadata</strong> (<em>string</em>) – SAML Metadata XML</p></li>
<li><p><strong>key</strong> (<em>string</em>) – x509 key</p></li>
<li><p><strong>cert</strong> (<em>string</em>) – x509 cert</p></li>
<li><p><strong>sign_algorithm</strong> (<em>string</em>) – Signature algorithm method</p></li>
<li><p><strong>digest_algorithm</strong> (<em>string</em>) – Digest algorithm method</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Signed Metadata</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-onelogin.saml2.response">
<span id="onelogin-saml2-response-module"></span><h2>onelogin.saml2.response module<a class="headerlink" href="#module-onelogin.saml2.response" title="Permalink to this heading"></a></h2>
<p>OneLogin_Saml2_Response class</p>
<p>SAML Response class of SAML Python Toolkit.</p>
<dl class="py class">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">onelogin.saml2.response.</span></span><span class="sig-name descname"><span class="pre">OneLogin_Saml2_Response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">response</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This class handles a SAML Response. It parses or validates
a Logout Response object.</p>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.check_one_authnstatement">
<span class="sig-name descname"><span class="pre">check_one_authnstatement</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.check_one_authnstatement"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.check_one_authnstatement" title="Permalink to this definition"></a></dt>
<dd><p>Checks that the samlp:Response/saml:Assertion/saml:AuthnStatement element exists and is unique.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.check_one_condition">
<span class="sig-name descname"><span class="pre">check_one_condition</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.check_one_condition"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.check_one_condition" title="Permalink to this definition"></a></dt>
<dd><p>Checks that the samlp:Response/saml:Assertion/saml:Conditions element exists and is unique.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.check_status">
<span class="sig-name descname"><span class="pre">check_status</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.check_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.check_status" title="Permalink to this definition"></a></dt>
<dd><p>Check if the status of the response is success or not</p>
<dl class="field-list simple">
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p>Exception. If the status is not success</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.get_assertion_id">
<span class="sig-name descname"><span class="pre">get_assertion_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.get_assertion_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.get_assertion_id" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>the ID of the assertion in the response</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.get_assertion_issue_instant">
<span class="sig-name descname"><span class="pre">get_assertion_issue_instant</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.get_assertion_issue_instant"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.get_assertion_issue_instant" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>the IssueInstant of the assertion in the response</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>unix/posix timestamp|None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.get_assertion_not_on_or_after">
<span class="sig-name descname"><span class="pre">get_assertion_not_on_or_after</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.get_assertion_not_on_or_after"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.get_assertion_not_on_or_after" title="Permalink to this definition"></a></dt>
<dd><p>Returns the NotOnOrAfter value of the valid SubjectConfirmationData node if any</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.get_attributes">
<span class="sig-name descname"><span class="pre">get_attributes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.get_attributes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.get_attributes" title="Permalink to this definition"></a></dt>
<dd><p>Gets the Attributes from the AttributeStatement element.
EncryptedAttributes are not supported</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.get_audiences">
<span class="sig-name descname"><span class="pre">get_audiences</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.get_audiences"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.get_audiences" title="Permalink to this definition"></a></dt>
<dd><p>Gets the audiences</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The valid audiences for the SAML Response</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.get_authn_contexts">
<span class="sig-name descname"><span class="pre">get_authn_contexts</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.get_authn_contexts"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.get_authn_contexts" title="Permalink to this definition"></a></dt>
<dd><p>Gets the authentication contexts</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The authentication classes for the SAML Response</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.get_error">
<span class="sig-name descname"><span class="pre">get_error</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.get_error"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.get_error" title="Permalink to this definition"></a></dt>
<dd><p>After executing a validation process, if it fails this method returns the cause</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.get_friendlyname_attributes">
<span class="sig-name descname"><span class="pre">get_friendlyname_attributes</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.get_friendlyname_attributes"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.get_friendlyname_attributes" title="Permalink to this definition"></a></dt>
<dd><p>Gets the Attributes from the AttributeStatement element indexed by FiendlyName.
EncryptedAttributes are not supported</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.get_id">
<span class="sig-name descname"><span class="pre">get_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.get_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.get_id" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>the ID of the response</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.get_in_response_to">
<span class="sig-name descname"><span class="pre">get_in_response_to</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.get_in_response_to"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.get_in_response_to" title="Permalink to this definition"></a></dt>
<dd><p>Gets the ID of the request which this response is in response to
:returns: ID of AuthNRequest this Response is in response to or None if it is not present
:rtype: str</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.get_issuers">
<span class="sig-name descname"><span class="pre">get_issuers</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.get_issuers"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.get_issuers" title="Permalink to this definition"></a></dt>
<dd><p>Gets the issuers (from message and from assertion)</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The issuers</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.get_nameid">
<span class="sig-name descname"><span class="pre">get_nameid</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.get_nameid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.get_nameid" title="Permalink to this definition"></a></dt>
<dd><p>Gets the NameID provided by the SAML Response from the IdP</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>NameID (value)</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string|None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.get_nameid_data">
<span class="sig-name descname"><span class="pre">get_nameid_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.get_nameid_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.get_nameid_data" title="Permalink to this definition"></a></dt>
<dd><p>Gets the NameID Data provided by the SAML Response from the IdP</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Name ID Data (Value, Format, NameQualifier, SPNameQualifier)</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.get_nameid_format">
<span class="sig-name descname"><span class="pre">get_nameid_format</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.get_nameid_format"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.get_nameid_format" title="Permalink to this definition"></a></dt>
<dd><p>Gets the NameID Format provided by the SAML Response from the IdP</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>NameID Format</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string|None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.get_nameid_nq">
<span class="sig-name descname"><span class="pre">get_nameid_nq</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.get_nameid_nq"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.get_nameid_nq" title="Permalink to this definition"></a></dt>
<dd><p>Gets the NameID NameQualifier provided by the SAML Response from the IdP</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>NameID NameQualifier</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string|None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.get_nameid_spnq">
<span class="sig-name descname"><span class="pre">get_nameid_spnq</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.get_nameid_spnq"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.get_nameid_spnq" title="Permalink to this definition"></a></dt>
<dd><p>Gets the NameID SP NameQualifier provided by the SAML response from the IdP.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>NameID SP NameQualifier</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string|None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.get_session_index">
<span class="sig-name descname"><span class="pre">get_session_index</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.get_session_index"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.get_session_index" title="Permalink to this definition"></a></dt>
<dd><p>Gets the SessionIndex from the AuthnStatement
Could be used to be stored in the local session in order
to be used in a future Logout Request that the SP could
send to the SP, to set what specific session must be deleted</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The SessionIndex value</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string|None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.get_session_not_on_or_after">
<span class="sig-name descname"><span class="pre">get_session_not_on_or_after</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.get_session_not_on_or_after"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.get_session_not_on_or_after" title="Permalink to this definition"></a></dt>
<dd><p>Gets the SessionNotOnOrAfter from the AuthnStatement
Could be used to set the local session expiration</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The SessionNotOnOrAfter value</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>time|None</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.get_xml_document">
<span class="sig-name descname"><span class="pre">get_xml_document</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.get_xml_document"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.get_xml_document" title="Permalink to this definition"></a></dt>
<dd><p>Returns the SAML Response document (If contains an encrypted assertion, decrypts it)</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Decrypted XML response document</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>DOMDocument</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.is_valid">
<span class="sig-name descname"><span class="pre">is_valid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">raise_exceptions</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.is_valid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.is_valid" title="Permalink to this definition"></a></dt>
<dd><p>Validates the response object.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>request_data</strong> (<em>dict</em>) – Request Data</p></li>
<li><p><strong>request_id</strong> (<em>string</em>) – Optional argument. The ID of the AuthNRequest sent by this SP to the IdP</p></li>
<li><p><strong>raise_exceptions</strong> (<em>Boolean</em>) – Whether to return false on failure or raise an exception</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>True if the SAML Response is valid, False if not</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.process_signed_elements">
<span class="sig-name descname"><span class="pre">process_signed_elements</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.process_signed_elements"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.process_signed_elements" title="Permalink to this definition"></a></dt>
<dd><dl class="simple">
<dt>Verifies the signature nodes:</dt><dd><ul class="simple">
<li><p>Checks that are Response or Assertion</p></li>
<li><p>Check that IDs and reference URI are unique and consistent.</p></li>
</ul>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The signed elements tag names</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.validate_num_assertions">
<span class="sig-name descname"><span class="pre">validate_num_assertions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.validate_num_assertions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.validate_num_assertions" title="Permalink to this definition"></a></dt>
<dd><p>Verifies that the document only contains a single Assertion (encrypted or not)</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>True if only 1 assertion encrypted or not</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.validate_signed_elements">
<span class="sig-name descname"><span class="pre">validate_signed_elements</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">signed_elements</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.validate_signed_elements"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.validate_signed_elements" title="Permalink to this definition"></a></dt>
<dd><p>Verifies that the document has the expected signed nodes.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>signed_elements</strong> (<em>list</em>) – The signed elements to be checked</p></li>
<li><p><strong>raise_exceptions</strong> (<em>Boolean</em>) – Whether to return false on failure or raise an exception</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.response.OneLogin_Saml2_Response.validate_timestamps">
<span class="sig-name descname"><span class="pre">validate_timestamps</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/response.html#OneLogin_Saml2_Response.validate_timestamps"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.response.OneLogin_Saml2_Response.validate_timestamps" title="Permalink to this definition"></a></dt>
<dd><p>Verifies that the document is valid according to Conditions Element</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>True if the condition is valid, False otherwise</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>bool</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-onelogin.saml2.settings">
<span id="onelogin-saml2-settings-module"></span><h2>onelogin.saml2.settings module<a class="headerlink" href="#module-onelogin.saml2.settings" title="Permalink to this heading"></a></h2>
<p>OneLogin_Saml2_Settings class</p>
<p>Copyright (c) 2010-2021 OneLogin, Inc.
MIT License</p>
<p>Setting class of OneLogin’s Python Toolkit.</p>
<dl class="py class">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">onelogin.saml2.settings.</span></span><span class="sig-name descname"><span class="pre">OneLogin_Saml2_Settings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_base_path</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sp_validation_only</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Handles the settings of the Python toolkits.</p>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.check_idp_settings">
<span class="sig-name descname"><span class="pre">check_idp_settings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.check_idp_settings"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.check_idp_settings" title="Permalink to this definition"></a></dt>
<dd><p>Checks the IdP settings info.
:param settings: Dict with settings data
:type settings: dict
:returns: Errors found on the IdP settings data
:rtype: list</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.check_settings">
<span class="sig-name descname"><span class="pre">check_settings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.check_settings"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.check_settings" title="Permalink to this definition"></a></dt>
<dd><p>Checks the settings info.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>settings</strong> (<em>dict</em>) – Dict with settings data</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Errors found on the settings data</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.check_sp_certs">
<span class="sig-name descname"><span class="pre">check_sp_certs</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.check_sp_certs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.check_sp_certs" title="Permalink to this definition"></a></dt>
<dd><p>Checks if the x509 certs of the SP exists and are valid.
:returns: If the x509 certs of the SP exists and are valid
:rtype: boolean</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.check_sp_settings">
<span class="sig-name descname"><span class="pre">check_sp_settings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">settings</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.check_sp_settings"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.check_sp_settings" title="Permalink to this definition"></a></dt>
<dd><p>Checks the SP settings info.
:param settings: Dict with settings data
:type settings: dict
:returns: Errors found on the SP settings data
:rtype: list</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.format_idp_cert">
<span class="sig-name descname"><span class="pre">format_idp_cert</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.format_idp_cert"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.format_idp_cert" title="Permalink to this definition"></a></dt>
<dd><p>Formats the IdP cert.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.format_idp_cert_multi">
<span class="sig-name descname"><span class="pre">format_idp_cert_multi</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.format_idp_cert_multi"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.format_idp_cert_multi" title="Permalink to this definition"></a></dt>
<dd><p>Formats the Multple IdP certs.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.format_sp_cert">
<span class="sig-name descname"><span class="pre">format_sp_cert</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.format_sp_cert"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.format_sp_cert" title="Permalink to this definition"></a></dt>
<dd><p>Formats the SP cert.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.format_sp_cert_new">
<span class="sig-name descname"><span class="pre">format_sp_cert_new</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.format_sp_cert_new"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.format_sp_cert_new" title="Permalink to this definition"></a></dt>
<dd><p>Formats the SP cert.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.format_sp_key">
<span class="sig-name descname"><span class="pre">format_sp_key</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.format_sp_key"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.format_sp_key" title="Permalink to this definition"></a></dt>
<dd><p>Formats the private key.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.get_base_path">
<span class="sig-name descname"><span class="pre">get_base_path</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.get_base_path"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.get_base_path" title="Permalink to this definition"></a></dt>
<dd><p>Returns base path</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The base toolkit folder path</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.get_cert_path">
<span class="sig-name descname"><span class="pre">get_cert_path</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.get_cert_path"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.get_cert_path" title="Permalink to this definition"></a></dt>
<dd><p>Returns cert path</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The cert folder path</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.get_contacts">
<span class="sig-name descname"><span class="pre">get_contacts</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.get_contacts"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.get_contacts" title="Permalink to this definition"></a></dt>
<dd><p>Gets contact data.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Contacts info</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.get_errors">
<span class="sig-name descname"><span class="pre">get_errors</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.get_errors"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.get_errors" title="Permalink to this definition"></a></dt>
<dd><p>Returns an array with the errors, the array is empty when the settings is ok.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Errors</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.get_idp_cert">
<span class="sig-name descname"><span class="pre">get_idp_cert</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.get_idp_cert"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.get_idp_cert" title="Permalink to this definition"></a></dt>
<dd><p>Returns the x509 public cert of the IdP.
:returns: IdP public cert
:rtype: string</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.get_idp_data">
<span class="sig-name descname"><span class="pre">get_idp_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.get_idp_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.get_idp_data" title="Permalink to this definition"></a></dt>
<dd><p>Gets the IdP data.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>IdP info</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.get_idp_slo_response_url">
<span class="sig-name descname"><span class="pre">get_idp_slo_response_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.get_idp_slo_response_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.get_idp_slo_response_url" title="Permalink to this definition"></a></dt>
<dd><p>Gets the IdP SLO return URL for IdP-initiated logout.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>an URL, the SLO return endpoint of the IdP</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.get_idp_slo_url">
<span class="sig-name descname"><span class="pre">get_idp_slo_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.get_idp_slo_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.get_idp_slo_url" title="Permalink to this definition"></a></dt>
<dd><p>Gets the IdP SLO URL.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>An URL, the SLO endpoint of the IdP</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.get_idp_sso_url">
<span class="sig-name descname"><span class="pre">get_idp_sso_url</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.get_idp_sso_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.get_idp_sso_url" title="Permalink to this definition"></a></dt>
<dd><p>Gets the IdP SSO URL.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>An URL, the SSO endpoint of the IdP</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.get_lib_path">
<span class="sig-name descname"><span class="pre">get_lib_path</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.get_lib_path"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.get_lib_path" title="Permalink to this definition"></a></dt>
<dd><p>Returns lib path</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The library folder path</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.get_organization">
<span class="sig-name descname"><span class="pre">get_organization</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.get_organization"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.get_organization" title="Permalink to this definition"></a></dt>
<dd><p>Gets organization data.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Organization info</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.get_schemas_path">
<span class="sig-name descname"><span class="pre">get_schemas_path</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.get_schemas_path"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.get_schemas_path" title="Permalink to this definition"></a></dt>
<dd><p>Returns schema path</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The schema folder path</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.get_security_data">
<span class="sig-name descname"><span class="pre">get_security_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.get_security_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.get_security_data" title="Permalink to this definition"></a></dt>
<dd><p>Gets security data.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Security info</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.get_sp_cert">
<span class="sig-name descname"><span class="pre">get_sp_cert</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.get_sp_cert"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.get_sp_cert" title="Permalink to this definition"></a></dt>
<dd><p>Returns the x509 public cert of the SP.
:returns: SP public cert
:rtype: string or None</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.get_sp_cert_new">
<span class="sig-name descname"><span class="pre">get_sp_cert_new</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.get_sp_cert_new"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.get_sp_cert_new" title="Permalink to this definition"></a></dt>
<dd><p>Returns the x509 public of the SP planned
to be used soon instead the other public cert
:returns: SP public cert new
:rtype: string or None</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.get_sp_data">
<span class="sig-name descname"><span class="pre">get_sp_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.get_sp_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.get_sp_data" title="Permalink to this definition"></a></dt>
<dd><p>Gets the SP data.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>SP info</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.get_sp_key">
<span class="sig-name descname"><span class="pre">get_sp_key</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.get_sp_key"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.get_sp_key" title="Permalink to this definition"></a></dt>
<dd><p>Returns the x509 private key of the SP.
:returns: SP private key
:rtype: string or None</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.get_sp_metadata">
<span class="sig-name descname"><span class="pre">get_sp_metadata</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.get_sp_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.get_sp_metadata" title="Permalink to this definition"></a></dt>
<dd><p>Gets the SP metadata. The XML representation.
:returns: SP metadata (xml)
:rtype: string</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.is_debug_active">
<span class="sig-name descname"><span class="pre">is_debug_active</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.is_debug_active"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.is_debug_active" title="Permalink to this definition"></a></dt>
<dd><p>Returns if the debug is active.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Debug parameter</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.is_strict">
<span class="sig-name descname"><span class="pre">is_strict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.is_strict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.is_strict" title="Permalink to this definition"></a></dt>
<dd><p>Returns if the ‘strict’ mode is active.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Strict parameter</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.metadata_class">
<span class="sig-name descname"><span class="pre">metadata_class</span></span><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.metadata_class" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="#onelogin.saml2.metadata.OneLogin_Saml2_Metadata" title="onelogin.saml2.metadata.OneLogin_Saml2_Metadata"><code class="xref py py-class docutils literal notranslate"><span class="pre">OneLogin_Saml2_Metadata</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.set_cert_path">
<span class="sig-name descname"><span class="pre">set_cert_path</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.set_cert_path"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.set_cert_path" title="Permalink to this definition"></a></dt>
<dd><p>Set a new cert path</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.set_strict">
<span class="sig-name descname"><span class="pre">set_strict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.set_strict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.set_strict" title="Permalink to this definition"></a></dt>
<dd><p>Activates or deactivates the strict mode.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>value</strong> (<em>boolean</em>) – Strict parameter</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.settings.OneLogin_Saml2_Settings.validate_metadata">
<span class="sig-name descname"><span class="pre">validate_metadata</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">xml</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#OneLogin_Saml2_Settings.validate_metadata"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.OneLogin_Saml2_Settings.validate_metadata" title="Permalink to this definition"></a></dt>
<dd><p>Validates an XML SP Metadata.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>xml</strong> (<em>string</em>) – Metadata’s XML that will be validate</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The list of found errors</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="onelogin.saml2.settings.validate_url">
<span class="sig-prename descclassname"><span class="pre">onelogin.saml2.settings.</span></span><span class="sig-name descname"><span class="pre">validate_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_single_label_domain</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/settings.html#validate_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.settings.validate_url" title="Permalink to this definition"></a></dt>
<dd><p>Auxiliary method to validate an urllib
:param url: An url to be validated
:type url: string
:param allow_single_label_domain: In order to allow or not single label domain
:type url: bool
:returns: True if the url is valid
:rtype: bool</p>
</dd></dl>
</section>
<section id="module-onelogin.saml2.utils">
<span id="onelogin-saml2-utils-module"></span><h2>onelogin.saml2.utils module<a class="headerlink" href="#module-onelogin.saml2.utils" title="Permalink to this heading"></a></h2>
<p>OneLogin_Saml2_Utils class</p>
<p>Auxiliary class of SAML Python Toolkit.</p>
<dl class="py class">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">onelogin.saml2.utils.</span></span><span class="sig-name descname"><span class="pre">OneLogin_Saml2_Utils</span></span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Auxiliary class that contains several utility methods to parse time,
urls, add sign, encrypt, decrypt, sign validation, handle xml …</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.ASSERTION_SIGNATURE_XPATH">
<span class="sig-name descname"><span class="pre">ASSERTION_SIGNATURE_XPATH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'/samlp:Response/saml:Assertion/ds:Signature'</span></em><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.ASSERTION_SIGNATURE_XPATH" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.RESPONSE_SIGNATURE_XPATH">
<span class="sig-name descname"><span class="pre">RESPONSE_SIGNATURE_XPATH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'/samlp:Response/ds:Signature'</span></em><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.RESPONSE_SIGNATURE_XPATH" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.TIME_FORMAT">
<span class="sig-name descname"><span class="pre">TIME_FORMAT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'%Y-%m-%dT%H:%M:%SZ'</span></em><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.TIME_FORMAT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.TIME_FORMAT_2">
<span class="sig-name descname"><span class="pre">TIME_FORMAT_2</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'%Y-%m-%dT%H:%M:%S.%fZ'</span></em><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.TIME_FORMAT_2" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.TIME_FORMAT_WITH_FRAGMENT">
<span class="sig-name descname"><span class="pre">TIME_FORMAT_WITH_FRAGMENT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">re.compile('^(\\d{4,4}-\\d{2,2}-\\d{2,2}T\\d{2,2}:\\d{2,2}:\\d{2,2})(\\.\\d*)?Z?$')</span></em><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.TIME_FORMAT_WITH_FRAGMENT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.add_sign">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">add_sign</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">xml</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cert</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sign_algorithm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'http://www.w3.org/2001/04/xmldsig-more#rsa-sha256'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">digest_algorithm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'http://www.w3.org/2001/04/xmlenc#sha256'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.add_sign"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.add_sign" title="Permalink to this definition"></a></dt>
<dd><p>Adds signature key and senders certificate to an element (Message or
Assertion).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>xml</strong> – The element we should sign</p></li>
<li><p><strong>key</strong> – The private key</p></li>
<li><p><strong>cert</strong> – The public</p></li>
<li><p><strong>debug</strong> – Activate the xmlsec debug</p></li>
<li><p><strong>sign_algorithm</strong> (<em>string</em>) – Signature algorithm method</p></li>
<li><p><strong>digest_algorithm</strong> (<em>string</em>) – Digest algorithm method</p></li>
</ul>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string | Document</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Signed XML</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.b64decode">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">b64decode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.b64decode"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.b64decode" title="Permalink to this definition"></a></dt>
<dd><p>base64 decode</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.b64encode">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">b64encode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.b64encode"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.b64encode" title="Permalink to this definition"></a></dt>
<dd><p>base64 encode</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.calculate_x509_fingerprint">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">calculate_x509_fingerprint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x509_cert</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">alg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'sha1'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.calculate_x509_fingerprint"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.calculate_x509_fingerprint" title="Permalink to this definition"></a></dt>
<dd><p>Calculates the fingerprint of a formatted x509cert.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>x509_cert</strong> – x509 cert formatted</p></li>
<li><p><strong>alg</strong> – The algorithm to build the fingerprint</p></li>
</ul>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>fingerprint</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.decode_base64_and_inflate">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">decode_base64_and_inflate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_zip</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.decode_base64_and_inflate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.decode_base64_and_inflate" title="Permalink to this definition"></a></dt>
<dd><p>base64 decodes and then inflates according to RFC1951
:param value: a deflated and encoded string
:type value: string
:param ignore_zip: ignore zip errors
:returns: the string after decoding and inflating
:rtype: string</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.decrypt_element">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">decrypt_element</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">encrypted_data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inplace</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.decrypt_element"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.decrypt_element" title="Permalink to this definition"></a></dt>
<dd><p>Decrypts an encrypted element.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>encrypted_data</strong> – The encrypted data.</p></li>
<li><p><strong>key</strong> – The key.</p></li>
<li><p><strong>debug</strong> – Activate the xmlsec debug</p></li>
<li><p><strong>inplace</strong> – update passed data with decrypted result</p></li>
</ul>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>lxml.etree.Element | DOMElement | basestring</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>bool</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The decrypted element.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>lxml.etree.Element</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.deflate_and_base64_encode">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">deflate_and_base64_encode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.deflate_and_base64_encode"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.deflate_and_base64_encode" title="Permalink to this definition"></a></dt>
<dd><p>Deflates and then base64 encodes a string
:param value: The string to deflate and encode
:type value: string
:returns: The deflated and encoded string
:rtype: string</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.delete_local_session">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">delete_local_session</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">callback</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.delete_local_session"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.delete_local_session" title="Permalink to this definition"></a></dt>
<dd><p>Deletes the local session.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.escape_url">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">escape_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">lowercase_urlencoding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.escape_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.escape_url" title="Permalink to this definition"></a></dt>
<dd><p>escape the non-safe symbols in url
The encoding used by ADFS 3.0 is not compatible with
python’s quote_plus (ADFS produces lower case hex numbers and quote_plus produces
upper case hex numbers)
:param url: the url to escape
:type url: str</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>lowercase_urlencoding</strong> (<em>boolean</em>) – lowercase or no</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>the escaped url</p>
</dd>
</dl>
<p>:rtype str</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.format_cert">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">format_cert</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cert</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">heads</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.format_cert"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.format_cert" title="Permalink to this definition"></a></dt>
<dd><p>Returns a x509 cert (adding header & footer if required).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cert</strong> – A x509 unformatted cert</p></li>
<li><p><strong>heads</strong> – True if we want to include head and footer</p></li>
</ul>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>boolean</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>Formatted cert</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.format_finger_print">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">format_finger_print</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fingerprint</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.format_finger_print"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.format_finger_print" title="Permalink to this definition"></a></dt>
<dd><p>Formats a fingerprint.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>fingerprint</strong> – fingerprint</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Formatted fingerprint</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.format_private_key">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">format_private_key</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">heads</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.format_private_key"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.format_private_key" title="Permalink to this definition"></a></dt>
<dd><p>Returns a private key (adding header & footer if required).</p>
<p>:param key A private key
:type: string</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>heads</strong> – True if we want to include head and footer</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>boolean</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Formated private key</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.generate_name_id">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">generate_name_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sp_nq</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sp_format</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cert</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nq</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.generate_name_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.generate_name_id" title="Permalink to this definition"></a></dt>
<dd><p>Generates a nameID.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>value</strong> – fingerprint</p></li>
<li><p><strong>sp_nq</strong> – SP Name Qualifier</p></li>
<li><p><strong>sp_format</strong> – SP Format</p></li>
<li><p><strong>cert</strong> – IdP Public Cert to encrypt the nameID</p></li>
<li><p><strong>debug</strong> – Activate the xmlsec debug</p></li>
<li><p><strong>nq</strong> – IDP Name Qualifier</p></li>
</ul>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>bool</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>DOMElement | XMLSec nameID</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.generate_unique_id">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">generate_unique_id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.generate_unique_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.generate_unique_id" title="Permalink to this definition"></a></dt>
<dd><p>Generates an unique string (used for example as ID for assertions).</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>A unique string</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.get_expire_time">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_expire_time</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cache_duration</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">valid_until</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.get_expire_time"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.get_expire_time" title="Permalink to this definition"></a></dt>
<dd><p>Compares 2 dates and returns the earliest.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>cache_duration</strong> – The duration, as a string.</p></li>
<li><p><strong>valid_until</strong> – The valid until date, as a string or as a timestamp</p></li>
</ul>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The expiration time.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.get_self_host">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_self_host</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.get_self_host"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.get_self_host" title="Permalink to this definition"></a></dt>
<dd><p>Returns the current host (which may include a port number part).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>request_data</strong> – The request as a dict</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The current host</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.get_self_routed_url_no_query">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_self_routed_url_no_query</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.get_self_routed_url_no_query"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.get_self_routed_url_no_query" title="Permalink to this definition"></a></dt>
<dd><p>Returns the routed URL of the current host + current view.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>request_data</strong> – The request as a dict</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The url of current host + current view</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.get_self_url">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_self_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.get_self_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.get_self_url" title="Permalink to this definition"></a></dt>
<dd><p>Returns the URL of the current host + current view + query.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>request_data</strong> – The request as a dict</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The url of current host + current view + query</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.get_self_url_host">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_self_url_host</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.get_self_url_host"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.get_self_url_host" title="Permalink to this definition"></a></dt>
<dd><p>Returns the protocol + the current host + the port (if different than
common ports).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>request_data</strong> – The request as a dict</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Url</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.get_self_url_no_query">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_self_url_no_query</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.get_self_url_no_query"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.get_self_url_no_query" title="Permalink to this definition"></a></dt>
<dd><p>Returns the URL of the current host + current view.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>request_data</strong> – The request as a dict</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The url of current host + current view</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.get_status">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dom</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.get_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.get_status" title="Permalink to this definition"></a></dt>
<dd><p>Gets Status from a Response.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>dom</strong> – The Response as XML</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>Document</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The Status, an array with the code and a message.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.is_https">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_https</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">request_data</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.is_https"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.is_https" title="Permalink to this definition"></a></dt>
<dd><p>Checks if https or http.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>request_data</strong> – The request as a dict</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>False if https is not active</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>boolean</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.normalize_url">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">normalize_url</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.normalize_url"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.normalize_url" title="Permalink to this definition"></a></dt>
<dd><p>Returns normalized URL for comparison.
This method converts the netloc to lowercase, as it should be case-insensitive (per RFC 4343, RFC 7617)
If standardization fails, the original URL is returned
Python documentation indicates that URL split also normalizes query strings if empty query fields are present</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>url</strong> (<em>String</em>) – URL</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A normalized URL, or the given URL string if parsing fails</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>String</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.now">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">now</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.now"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.now" title="Permalink to this definition"></a></dt>
<dd><dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>unix timestamp of actual time.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.parse_SAML_to_time">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_SAML_to_time</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timestr</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.parse_SAML_to_time"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.parse_SAML_to_time" title="Permalink to this definition"></a></dt>
<dd><p>Converts a SAML2 timestamp on the form yyyy-mm-ddThh:mm:ss(.s+)?Z
to a UNIX timestamp. The sub-second part is ignored.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>timestr</strong> – The time we should convert (SAML Timestamp).</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Converted to a unix timestamp.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.parse_duration">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_duration</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">duration</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.parse_duration"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.parse_duration" title="Permalink to this definition"></a></dt>
<dd><p>Interprets a ISO8601 duration value relative to a given timestamp.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>duration</strong> – The duration, as a string.</p></li>
<li><p><strong>timestamp</strong> – The unix timestamp we should apply the duration to.
Optional, default to the current time.</p></li>
</ul>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The new timestamp, after the duration is applied.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>int</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.parse_time_to_SAML">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">parse_time_to_SAML</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">time</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.parse_time_to_SAML"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.parse_time_to_SAML" title="Permalink to this definition"></a></dt>
<dd><p>Converts a UNIX timestamp to SAML2 timestamp on the form
yyyy-mm-ddThh:mm:ss(.s+)?Z.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>time</strong> – The time we should convert (DateTime).</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>SAML2 timestamp.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.redirect">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">redirect</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">request_data</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.redirect"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.redirect" title="Permalink to this definition"></a></dt>
<dd><p>Executes a redirection to the provided url (or return the target url).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>url</strong> – The target url</p></li>
<li><p><strong>parameters</strong> – Extra parameters to be passed as part of the url</p></li>
<li><p><strong>request_data</strong> – The request as a dict</p></li>
</ul>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>dict</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>Url</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.sign_binary">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">sign_binary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">msg</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">algorithm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">__Transform('rsa-sha256',</span> <span class="pre">'http://www.w3.org/2001/04/xmldsig-more#rsa-sha256',</span> <span class="pre">8)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.sign_binary"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.sign_binary" title="Permalink to this definition"></a></dt>
<dd><p>Sign binary message</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>msg</strong> – The element we should validate</p></li>
<li><p><strong>key</strong> – The private key</p></li>
<li><p><strong>debug</strong> – Activate the xmlsec debug</p></li>
</ul>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>bytes</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>bool</p>
</dd>
</dl>
<p>:return signed message
:rtype str</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.validate_binary_sign">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate_binary_sign</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">signed_query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">signature</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cert</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">algorithm</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'http://www.w3.org/2001/04/xmldsig-more#rsa-sha256'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.validate_binary_sign"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.validate_binary_sign" title="Permalink to this definition"></a></dt>
<dd><p>Validates signed binary data (Used to validate GET Signature).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>signed_query</strong> – The element we should validate</p></li>
<li><p><strong>signature</strong> – The signature that will be validate</p></li>
<li><p><strong>cert</strong> – The public cert</p></li>
<li><p><strong>algorithm</strong> – Signature algorithm</p></li>
<li><p><strong>debug</strong> – Activate the xmlsec debug</p></li>
</ul>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.validate_metadata_sign">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate_metadata_sign</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">xml</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cert</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fingerprint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fingerprintalg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'sha1'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validatecert</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.validate_metadata_sign"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.validate_metadata_sign" title="Permalink to this definition"></a></dt>
<dd><p>Validates a signature of a EntityDescriptor.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>xml</strong> – The element we should validate</p></li>
<li><p><strong>cert</strong> – The public cert</p></li>
<li><p><strong>fingerprint</strong> – The fingerprint of the public cert</p></li>
<li><p><strong>fingerprintalg</strong> – The algorithm used to build the fingerprint</p></li>
<li><p><strong>validatecert</strong> – If true, will verify the signature and if the cert is valid.</p></li>
<li><p><strong>debug</strong> – Activate the xmlsec debug</p></li>
<li><p><strong>raise_exceptions</strong> (<em>Boolean</em>) – Whether to return false on failure or raise an exception</p></li>
</ul>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string | Document</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>bool</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.validate_node_sign">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate_node_sign</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">signature_node</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">elem</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cert</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fingerprint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fingerprintalg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'sha1'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validatecert</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.validate_node_sign"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.validate_node_sign" title="Permalink to this definition"></a></dt>
<dd><p>Validates a signature node.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>signature_node</strong> – The signature node</p></li>
<li><p><strong>xml</strong> – The element we should validate</p></li>
<li><p><strong>cert</strong> – The public cert</p></li>
<li><p><strong>fingerprint</strong> – The fingerprint of the public cert</p></li>
<li><p><strong>fingerprintalg</strong> – The algorithm used to build the fingerprint</p></li>
<li><p><strong>validatecert</strong> – If true, will verify the signature and if the cert is valid.</p></li>
<li><p><strong>debug</strong> – Activate the xmlsec debug</p></li>
<li><p><strong>raise_exceptions</strong> (<em>Boolean</em>) – Whether to return false on failure or raise an exception</p></li>
</ul>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>Node</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Document</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>bool</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.utils.OneLogin_Saml2_Utils.validate_sign">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate_sign</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">xml</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cert</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fingerprint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">fingerprintalg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'sha1'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">validatecert</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">xpath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">multicerts</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#OneLogin_Saml2_Utils.validate_sign"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.OneLogin_Saml2_Utils.validate_sign" title="Permalink to this definition"></a></dt>
<dd><p>Validates a signature (Message or Assertion).</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>xml</strong> – The element we should validate</p></li>
<li><p><strong>cert</strong> – The public cert</p></li>
<li><p><strong>fingerprint</strong> – The fingerprint of the public cert</p></li>
<li><p><strong>fingerprintalg</strong> – The algorithm used to build the fingerprint</p></li>
<li><p><strong>validatecert</strong> – If true, will verify the signature and if the cert is valid.</p></li>
<li><p><strong>debug</strong> – Activate the xmlsec debug</p></li>
<li><p><strong>xpath</strong> – The xpath of the signed element</p></li>
<li><p><strong>multicerts</strong> – Multiple public certs</p></li>
<li><p><strong>raise_exceptions</strong> (<em>Boolean</em>) – Whether to return false on failure or raise an exception</p></li>
</ul>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string | Document</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>bool</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>bool</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>string</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="onelogin.saml2.utils.return_false_on_exception">
<span class="sig-prename descclassname"><span class="pre">onelogin.saml2.utils.</span></span><span class="sig-name descname"><span class="pre">return_false_on_exception</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/utils.html#return_false_on_exception"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.utils.return_false_on_exception" title="Permalink to this definition"></a></dt>
<dd><p>Decorator. When applied to a function, it will, by default, suppress any exceptions
raised by that function and return False. It may be overridden by passing a
“raise_exceptions” keyword argument when calling the wrapped function.</p>
</dd></dl>
</section>
<section id="module-onelogin.saml2.xml_templates">
<span id="onelogin-saml2-xml-templates-module"></span><h2>onelogin.saml2.xml_templates module<a class="headerlink" href="#module-onelogin.saml2.xml_templates" title="Permalink to this heading"></a></h2>
<p>OneLogin_Saml2_Auth class</p>
<p>Main class of SAML Python Toolkit.</p>
<p>Initializes the SP SAML instance</p>
<dl class="py class">
<dt class="sig sig-object py" id="onelogin.saml2.xml_templates.OneLogin_Saml2_Templates">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">onelogin.saml2.xml_templates.</span></span><span class="sig-name descname"><span class="pre">OneLogin_Saml2_Templates</span></span><a class="reference internal" href="_modules/onelogin/saml2/xml_templates.html#OneLogin_Saml2_Templates"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xml_templates.OneLogin_Saml2_Templates" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.ATTRIBUTE">
<span class="sig-name descname"><span class="pre">ATTRIBUTE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'\n</span>        <span class="pre"><saml:Attribute</span> <span class="pre">Name="%s"</span> <span class="pre">NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:basic">\n</span>            <span class="pre"><saml:AttributeValue</span> <span class="pre">xsi:type="xs:string">%s</saml:AttributeValue>\n</span>        <span class="pre"></saml:Attribute>'</span></em><a class="headerlink" href="#onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.ATTRIBUTE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.AUTHN_REQUEST">
<span class="sig-name descname"><span class="pre">AUTHN_REQUEST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'<samlp:AuthnRequest\n</span>  <span class="pre">xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol"\n</span>  <span class="pre">xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"\n</span>  <span class="pre">ID="%(id)s"\n</span>  <span class="pre">Version="2.0"%(provider_name)s%(force_authn_str)s%(is_passive_str)s\n</span>  <span class="pre">IssueInstant="%(issue_instant)s"\n</span>  <span class="pre">Destination="%(destination)s"\n</span>  <span class="pre">ProtocolBinding="%(acs_binding)s"\n</span>  <span class="pre">AssertionConsumerServiceURL="%(assertion_url)s"%(attr_consuming_service_str)s>\n</span>    <span class="pre"><saml:Issuer>%(entity_id)s</saml:Issuer>%(subject_str)s%(nameid_policy_str)s\n%(requested_authn_context_str)s\n</samlp:AuthnRequest>'</span></em><a class="headerlink" href="#onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.AUTHN_REQUEST" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.LOGOUT_REQUEST">
<span class="sig-name descname"><span class="pre">LOGOUT_REQUEST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'<samlp:LogoutRequest\n</span>  <span class="pre">xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol"\n</span>  <span class="pre">xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"\n</span>  <span class="pre">ID="%(id)s"\n</span>  <span class="pre">Version="2.0"\n</span>  <span class="pre">IssueInstant="%(issue_instant)s"\n</span>  <span class="pre">Destination="%(single_logout_url)s">\n</span>    <span class="pre"><saml:Issuer>%(entity_id)s</saml:Issuer>\n</span>    <span class="pre">%(name_id)s\n</span>    <span class="pre">%(session_index)s\n</samlp:LogoutRequest>'</span></em><a class="headerlink" href="#onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.LOGOUT_REQUEST" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.LOGOUT_RESPONSE">
<span class="sig-name descname"><span class="pre">LOGOUT_RESPONSE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'<samlp:LogoutResponse\n</span>  <span class="pre">xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol"\n</span>  <span class="pre">xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"\n</span>  <span class="pre">ID="%(id)s"\n</span>  <span class="pre">Version="2.0"\n</span>  <span class="pre">IssueInstant="%(issue_instant)s"\n</span>  <span class="pre">Destination="%(destination)s"\n</span>  <span class="pre">InResponseTo="%(in_response_to)s">\n</span>    <span class="pre"><saml:Issuer>%(entity_id)s</saml:Issuer>\n</span>    <span class="pre"><samlp:Status>\n</span>        <span class="pre"><samlp:StatusCode</span> <span class="pre">Value="%(status)s"</span> <span class="pre">/>\n</span>    <span class="pre"></samlp:Status>\n</samlp:LogoutResponse>'</span></em><a class="headerlink" href="#onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.LOGOUT_RESPONSE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.MD_ATTR_CONSUMER_SERVICE">
<span class="sig-name descname"><span class="pre">MD_ATTR_CONSUMER_SERVICE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'</span>        <span class="pre"><md:AttributeConsumingService</span> <span class="pre">index="1">\n</span>            <span class="pre"><md:ServiceName</span> <span class="pre">xml:lang="en">%(service_name)s</md:ServiceName>\n%(attr_cs_desc)s%(requested_attribute_str)s\n</span>        <span class="pre"></md:AttributeConsumingService>\n'</span></em><a class="headerlink" href="#onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.MD_ATTR_CONSUMER_SERVICE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.MD_CONTACT_PERSON">
<span class="sig-name descname"><span class="pre">MD_CONTACT_PERSON</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'</span>    <span class="pre"><md:ContactPerson</span> <span class="pre">contactType="%(type)s">\n</span>        <span class="pre"><md:GivenName>%(name)s</md:GivenName>\n</span>        <span class="pre"><md:EmailAddress>%(email)s</md:EmailAddress>\n</span>    <span class="pre"></md:ContactPerson>'</span></em><a class="headerlink" href="#onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.MD_CONTACT_PERSON" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.MD_ENTITY_DESCRIPTOR">
<span class="sig-name descname"><span class="pre">MD_ENTITY_DESCRIPTOR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'<?xml</span> <span class="pre">version="1.0"?>\n<md:EntityDescriptor</span> <span class="pre">xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata"\n</span>                     <span class="pre">%(valid)s\n</span>                     <span class="pre">%(cache)s\n</span>                     <span class="pre">entityID="%(entity_id)s">\n</span>    <span class="pre"><md:SPSSODescriptor</span> <span class="pre">AuthnRequestsSigned="%(authnsign)s"</span> <span class="pre">WantAssertionsSigned="%(wsign)s"</span> <span class="pre">protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol">\n%(sls)s</span>        <span class="pre"><md:NameIDFormat>%(name_id_format)s</md:NameIDFormat>\n</span>        <span class="pre"><md:AssertionConsumerService</span> <span class="pre">Binding="%(binding)s"\n</span>                                     <span class="pre">Location="%(location)s"\n</span>                                     <span class="pre">index="1"</span> <span class="pre">/>\n%(attribute_consuming_service)s</span>    <span class="pre"></md:SPSSODescriptor>\n%(organization)s\n%(contacts)s\n</md:EntityDescriptor>'</span></em><a class="headerlink" href="#onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.MD_ENTITY_DESCRIPTOR" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.MD_ORGANISATION">
<span class="sig-name descname"><span class="pre">MD_ORGANISATION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'</span>    <span class="pre"><md:Organization>\n</span>        <span class="pre"><md:OrganizationName</span> <span class="pre">xml:lang="%(lang)s">%(name)s</md:OrganizationName>\n</span>        <span class="pre"><md:OrganizationDisplayName</span> <span class="pre">xml:lang="%(lang)s">%(display_name)s</md:OrganizationDisplayName>\n</span>        <span class="pre"><md:OrganizationURL</span> <span class="pre">xml:lang="%(lang)s">%(url)s</md:OrganizationURL>\n</span>    <span class="pre"></md:Organization>'</span></em><a class="headerlink" href="#onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.MD_ORGANISATION" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.MD_REQUESTED_ATTRIBUTE">
<span class="sig-name descname"><span class="pre">MD_REQUESTED_ATTRIBUTE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'</span>            <span class="pre"><md:RequestedAttribute</span> <span class="pre">Name="%(req_attr_name)s"%(req_attr_nameformat_str)s%(req_attr_isrequired_str)s%(req_attr_aux_str)s'</span></em><a class="headerlink" href="#onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.MD_REQUESTED_ATTRIBUTE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.MD_SLS">
<span class="sig-name descname"><span class="pre">MD_SLS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'</span>        <span class="pre"><md:SingleLogoutService</span> <span class="pre">Binding="%(binding)s"\n</span>                                <span class="pre">Location="%(location)s"</span> <span class="pre">/>\n'</span></em><a class="headerlink" href="#onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.MD_SLS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.RESPONSE">
<span class="sig-name descname"><span class="pre">RESPONSE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'<samlp:Response\n</span>  <span class="pre">xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol"\n</span>  <span class="pre">xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"\n</span>  <span class="pre">ID="%(id)s"\n</span>  <span class="pre">InResponseTo="%(in_response_to)s"\n</span>  <span class="pre">Version="2.0"\n</span>  <span class="pre">IssueInstant="%(issue_instant)s"\n</span>  <span class="pre">Destination="%(destination)s">\n</span>    <span class="pre"><saml:Issuer>%(entity_id)s</saml:Issuer>\n</span>    <span class="pre"><samlp:Status</span> <span class="pre">xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol">\n</span>        <span class="pre"><samlp:StatusCode\n</span>          <span class="pre">xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol"\n</span>          <span class="pre">Value="%(status)s">\n</span>        <span class="pre"></samlp:StatusCode>\n</span>    <span class="pre"></samlp:Status>\n</span>    <span class="pre"><saml:Assertion\n</span>        <span class="pre">xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\n</span>        <span class="pre">xmlns:xs="http://www.w3.org/2001/XMLSchema"\n</span>        <span class="pre">Version="2.0"\n</span>        <span class="pre">ID="%(assertion_id)s"\n</span>        <span class="pre">IssueInstant="%(issue_instant)s">\n</span>        <span class="pre"><saml:Issuer>%(entity_id)s</saml:Issuer>\n</span>        <span class="pre"><saml:Subject>\n</span>            <span class="pre"><saml:NameID\n</span>              <span class="pre">NameQualifier="%(entity_id)s"\n</span>              <span class="pre">SPNameQualifier="%(requester)s"\n</span>              <span class="pre">Format="%(name_id_policy)s">%(name_id)s</saml:NameID>\n</span>            <span class="pre"><saml:SubjectConfirmation</span> <span class="pre">Method="%(cm)s">\n</span>                <span class="pre"><saml:SubjectConfirmationData\n</span>                  <span class="pre">NotOnOrAfter="%(not_after)s"\n</span>                  <span class="pre">InResponseTo="%(in_response_to)s"\n</span>                  <span class="pre">Recipient="%(destination)s">\n</span>                <span class="pre"></saml:SubjectConfirmationData>\n</span>            <span class="pre"></saml:SubjectConfirmation>\n</span>        <span class="pre"></saml:Subject>\n</span>        <span class="pre"><saml:Conditions</span> <span class="pre">NotBefore="%(not_before)s"</span> <span class="pre">NotOnOrAfter="%(not_after)s">\n</span>            <span class="pre"><saml:AudienceRestriction>\n</span>                <span class="pre"><saml:Audience>%(requester)s</saml:Audience>\n</span>            <span class="pre"></saml:AudienceRestriction>\n</span>        <span class="pre"></saml:Conditions>\n</span>        <span class="pre"><saml:AuthnStatement\n</span>          <span class="pre">AuthnInstant="%(issue_instant)s"\n</span>          <span class="pre">SessionIndex="%(session_index)s"\n</span>          <span class="pre">SessionNotOnOrAfter="%(not_after)s">\n%(authn_context)s\n</span>        <span class="pre"></saml:AuthnStatement>\n</span>        <span class="pre"><saml:AttributeStatement>\n%(attributes)s\n</span>        <span class="pre"></saml:AttributeStatement>\n</span>    <span class="pre"></saml:Assertion>\n</samlp:Response>'</span></em><a class="headerlink" href="#onelogin.saml2.xml_templates.OneLogin_Saml2_Templates.RESPONSE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-onelogin.saml2.xml_utils">
<span id="onelogin-saml2-xml-utils-module"></span><h2>onelogin.saml2.xml_utils module<a class="headerlink" href="#module-onelogin.saml2.xml_utils" title="Permalink to this heading"></a></h2>
<p>OneLogin_Saml2_XML class</p>
<p>Auxiliary class of SAML Python Toolkit.</p>
<dl class="py class">
<dt class="sig sig-object py" id="onelogin.saml2.xml_utils.OneLogin_Saml2_XML">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">onelogin.saml2.xml_utils.</span></span><span class="sig-name descname"><span class="pre">OneLogin_Saml2_XML</span></span><a class="reference internal" href="_modules/onelogin/saml2/xml_utils.html#OneLogin_Saml2_XML"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xml_utils.OneLogin_Saml2_XML" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.xml_utils.OneLogin_Saml2_XML.cleanup_namespaces">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">cleanup_namespaces</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tree_or_element</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">top_nsmap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keep_ns_prefixes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xml_utils.html#OneLogin_Saml2_XML.cleanup_namespaces"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xml_utils.OneLogin_Saml2_XML.cleanup_namespaces" title="Permalink to this definition"></a></dt>
<dd><p>Keeps the xmlns:xs namespace intact when etree.cleanup_namespaces is invoked.
:param tree_or_element: An XML tree or element
:type tree_or_element: etree.Element
:param top_nsmap: A mapping from namespace prefixes to namespace URIs
:type top_nsmap: dict
:param keep_ns_prefixes: List of prefixes that should not be removed as part of the cleanup
:type keep_ns_prefixes: list
:returns: An XML tree or element
:rtype: etree.Element</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.xml_utils.OneLogin_Saml2_XML.dump">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">dump</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">elem</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pretty_print</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_tail</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#onelogin.saml2.xml_utils.OneLogin_Saml2_XML.dump" title="Permalink to this definition"></a></dt>
<dd><p>Writes an element tree or element structure to sys.stdout. This function
should be used for debugging only.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.xml_utils.OneLogin_Saml2_XML.element_text">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">element_text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xml_utils.html#OneLogin_Saml2_XML.element_text"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xml_utils.OneLogin_Saml2_XML.element_text" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.xml_utils.OneLogin_Saml2_XML.extract_tag_text">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">extract_tag_text</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">xml</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tagname</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xml_utils.html#OneLogin_Saml2_XML.extract_tag_text"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xml_utils.OneLogin_Saml2_XML.extract_tag_text" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.xml_utils.OneLogin_Saml2_XML.make_child">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_child</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_parent</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">_tag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attrib</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nsmap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_extra</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#onelogin.saml2.xml_utils.OneLogin_Saml2_XML.make_child" title="Permalink to this definition"></a></dt>
<dd><p>SubElement(_parent, _tag, attrib=None, nsmap=None, <a href="#id1"><span class="problematic" id="id2">**</span></a>_extra)</p>
<p>Subelement factory. This function creates an element instance, and
appends it to an existing element.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.xml_utils.OneLogin_Saml2_XML.make_root">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">make_root</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">_tag</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">attrib</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">nsmap</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">_extra</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#onelogin.saml2.xml_utils.OneLogin_Saml2_XML.make_root" title="Permalink to this definition"></a></dt>
<dd><p>Element(_tag, attrib=None, nsmap=None, <a href="#id3"><span class="problematic" id="id4">**</span></a>_extra)</p>
<p>Element factory. This function returns an object implementing the
Element interface.</p>
<p>Also look at the <cite>_Element.makeelement()</cite> and
<cite>_BaseParser.makeelement()</cite> methods, which provide a faster way to
create an Element within a specific document or parser context.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.xml_utils.OneLogin_Saml2_XML.query">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">query</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">dom</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">query</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tagid</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xml_utils.html#OneLogin_Saml2_XML.query"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xml_utils.OneLogin_Saml2_XML.query" title="Permalink to this definition"></a></dt>
<dd><p>Extracts nodes that match the query from the Element</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>dom</strong> – The root of the lxml objet</p></li>
<li><p><strong>query</strong> (<em>String</em>) – Xpath Expresion</p></li>
<li><p><strong>context</strong> – Context Node</p></li>
<li><p><strong>tagid</strong> – Tag ID</p></li>
</ul>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>Element</p>
</dd>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>string</p>
</dd>
<dt class="field-even">Type<span class="colon">:</span></dt>
<dd class="field-even"><p>DOMElement</p>
</dd>
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The queried nodes</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>list</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.xml_utils.OneLogin_Saml2_XML.to_etree">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">to_etree</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">xml</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xml_utils.html#OneLogin_Saml2_XML.to_etree"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xml_utils.OneLogin_Saml2_XML.to_etree" title="Permalink to this definition"></a></dt>
<dd><p>Parses an XML document or fragment from a string.
:param xml: the string to parse
:type xml: str|bytes|xml.dom.minidom.Document|etree.Element
:returns: the root node
:rtype: OneLogin_Saml2_XML._element_class</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.xml_utils.OneLogin_Saml2_XML.to_string">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">to_string</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">xml</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xml_utils.html#OneLogin_Saml2_XML.to_string"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xml_utils.OneLogin_Saml2_XML.to_string" title="Permalink to this definition"></a></dt>
<dd><p>Serialize an element to an encoded string representation of its XML tree.
:param xml: The root node
:type xml: str|bytes|xml.dom.minidom.Document|etree.Element
:returns: string representation of xml
:rtype: string</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.xml_utils.OneLogin_Saml2_XML.validate_xml">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">validate_xml</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">xml</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schema</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xml_utils.html#OneLogin_Saml2_XML.validate_xml"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xml_utils.OneLogin_Saml2_XML.validate_xml" title="Permalink to this definition"></a></dt>
<dd><p>Validates a xml against a schema
:param xml: The xml that will be validated
:type xml: str|bytes|xml.dom.minidom.Document|etree.Element
:param schema: The schema
:type schema: string
:param debug: If debug is active, the parse-errors will be showed
:type debug: bool
:returns: Error code or the DomDocument of the xml
:rtype: xml.dom.minidom.Document</p>
</dd></dl>
</dd></dl>
</section>
<section id="module-onelogin.saml2.xmlparser">
<span id="onelogin-saml2-xmlparser-module"></span><h2>onelogin.saml2.xmlparser module<a class="headerlink" href="#module-onelogin.saml2.xmlparser" title="Permalink to this heading"></a></h2>
<p>lxml.etree protection</p>
<dl class="py exception">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.DTDForbidden">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">onelogin.saml2.xmlparser.</span></span><span class="sig-name descname"><span class="pre">DTDForbidden</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sysid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pubid</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xmlparser.html#DTDForbidden"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xmlparser.DTDForbidden" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></p>
<p>Document type definition is forbidden</p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.EntitiesForbidden">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">onelogin.saml2.xmlparser.</span></span><span class="sig-name descname"><span class="pre">EntitiesForbidden</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">base</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sysid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">pubid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">notation_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xmlparser.html#EntitiesForbidden"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xmlparser.EntitiesForbidden" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></p>
<p>Entity definition is forbidden</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.GlobalParserTLS">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">onelogin.saml2.xmlparser.</span></span><span class="sig-name descname"><span class="pre">GlobalParserTLS</span></span><a class="reference internal" href="_modules/onelogin/saml2/xmlparser.html#GlobalParserTLS"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xmlparser.GlobalParserTLS" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">_local</span></code></p>
<p>Thread local context for custom parser instances</p>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.GlobalParserTLS.createDefaultParser">
<span class="sig-name descname"><span class="pre">createDefaultParser</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xmlparser.html#GlobalParserTLS.createDefaultParser"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xmlparser.GlobalParserTLS.createDefaultParser" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.GlobalParserTLS.element_class">
<span class="sig-name descname"><span class="pre">element_class</span></span><a class="headerlink" href="#onelogin.saml2.xmlparser.GlobalParserTLS.element_class" title="Permalink to this definition"></a></dt>
<dd><p>alias of <a class="reference internal" href="#onelogin.saml2.xmlparser.RestrictedElement" title="onelogin.saml2.xmlparser.RestrictedElement"><code class="xref py py-class docutils literal notranslate"><span class="pre">RestrictedElement</span></code></a></p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.GlobalParserTLS.getDefaultParser">
<span class="sig-name descname"><span class="pre">getDefaultParser</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xmlparser.html#GlobalParserTLS.getDefaultParser"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xmlparser.GlobalParserTLS.getDefaultParser" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.GlobalParserTLS.parser_config">
<span class="sig-name descname"><span class="pre">parser_config</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'huge_tree':</span> <span class="pre">False,</span> <span class="pre">'no_network':</span> <span class="pre">True,</span> <span class="pre">'remove_comments':</span> <span class="pre">True,</span> <span class="pre">'remove_pis':</span> <span class="pre">True,</span> <span class="pre">'resolve_entities':</span> <span class="pre">False}</span></em><a class="headerlink" href="#onelogin.saml2.xmlparser.GlobalParserTLS.parser_config" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.GlobalParserTLS.setDefaultParser">
<span class="sig-name descname"><span class="pre">setDefaultParser</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parser</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xmlparser.html#GlobalParserTLS.setDefaultParser"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xmlparser.GlobalParserTLS.setDefaultParser" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.NotSupportedError">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">onelogin.saml2.xmlparser.</span></span><span class="sig-name descname"><span class="pre">NotSupportedError</span></span><a class="reference internal" href="_modules/onelogin/saml2/xmlparser.html#NotSupportedError"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xmlparser.NotSupportedError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ValueError</span></code></p>
<p>The operation is not supported</p>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.RestrictedElement">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">onelogin.saml2.xmlparser.</span></span><span class="sig-name descname"><span class="pre">RestrictedElement</span></span><a class="reference internal" href="_modules/onelogin/saml2/xmlparser.html#RestrictedElement"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xmlparser.RestrictedElement" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ElementBase</span></code></p>
<p>A restricted Element class that filters out instances of some classes</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.RestrictedElement.blacklist">
<span class="sig-name descname"><span class="pre">blacklist</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">(<class</span> <span class="pre">'lxml.etree._Entity'>,</span> <span class="pre"><class</span> <span class="pre">'lxml.etree._ProcessingInstruction'>,</span> <span class="pre"><class</span> <span class="pre">'lxml.etree._Comment'>)</span></em><a class="headerlink" href="#onelogin.saml2.xmlparser.RestrictedElement.blacklist" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.RestrictedElement.getchildren">
<span class="sig-name descname"><span class="pre">getchildren</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xmlparser.html#RestrictedElement.getchildren"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xmlparser.RestrictedElement.getchildren" title="Permalink to this definition"></a></dt>
<dd><p>Returns all direct children. The elements are returned in document
order.</p>
<dl class="field-list simple">
<dt class="field-odd">Deprecated<span class="colon">:</span></dt>
<dd class="field-odd"><p>Note that this method has been deprecated as of
ElementTree 1.3 and lxml 2.0. New code should use
<code class="docutils literal notranslate"><span class="pre">list(element)</span></code> or simply iterate over elements.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.RestrictedElement.getiterator">
<span class="sig-name descname"><span class="pre">getiterator</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">tags</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xmlparser.html#RestrictedElement.getiterator"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xmlparser.RestrictedElement.getiterator" title="Permalink to this definition"></a></dt>
<dd><p>Returns a sequence or iterator of all elements in the subtree in
document order (depth first pre-order), starting with this
element.</p>
<p>Can be restricted to find only elements with specific tags,
see <cite>iter</cite>.</p>
<dl class="field-list simple">
<dt class="field-odd">Deprecated<span class="colon">:</span></dt>
<dd class="field-odd"><p>Note that this method is deprecated as of
ElementTree 1.3 and lxml 2.0. It returns an iterator in
lxml, which diverges from the original ElementTree
behaviour. If you want an efficient iterator, use the
<code class="docutils literal notranslate"><span class="pre">element.iter()</span></code> method instead. You should only use this
method in new code if you require backwards compatibility
with older versions of lxml or ElementTree.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.RestrictedElement.iter">
<span class="sig-name descname"><span class="pre">iter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">tags</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xmlparser.html#RestrictedElement.iter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xmlparser.RestrictedElement.iter" title="Permalink to this definition"></a></dt>
<dd><p>Iterate over all elements in the subtree in document order (depth
first pre-order), starting with this element.</p>
<p>Can be restricted to find only elements with specific tags:
pass <code class="docutils literal notranslate"><span class="pre">"{ns}localname"</span></code> as tag. Either or both of <code class="docutils literal notranslate"><span class="pre">ns</span></code> and
<code class="docutils literal notranslate"><span class="pre">localname</span></code> can be <code class="docutils literal notranslate"><span class="pre">*</span></code> for a wildcard; <code class="docutils literal notranslate"><span class="pre">ns</span></code> can be empty
for no namespace. <code class="docutils literal notranslate"><span class="pre">"localname"</span></code> is equivalent to <code class="docutils literal notranslate"><span class="pre">"{}localname"</span></code>
(i.e. no namespace) but <code class="docutils literal notranslate"><span class="pre">"*"</span></code> is <code class="docutils literal notranslate"><span class="pre">"{*}*"</span></code> (any or no namespace),
not <code class="docutils literal notranslate"><span class="pre">"{}*"</span></code>.</p>
<p>You can also pass the Element, Comment, ProcessingInstruction and
Entity factory functions to look only for the specific element type.</p>
<p>Passing multiple tags (or a sequence of tags) instead of a single tag
will let the iterator return all elements matching any of these tags,
in document order.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.RestrictedElement.iterchildren">
<span class="sig-name descname"><span class="pre">iterchildren</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">tags</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reversed</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xmlparser.html#RestrictedElement.iterchildren"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xmlparser.RestrictedElement.iterchildren" title="Permalink to this definition"></a></dt>
<dd><p>Iterate over the children of this element.</p>
<p>As opposed to using normal iteration on this element, the returned
elements can be reversed with the ‘reversed’ keyword and restricted
to find only elements with specific tags, see <cite>iter</cite>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.RestrictedElement.iterdescendants">
<span class="sig-name descname"><span class="pre">iterdescendants</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">tags</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xmlparser.html#RestrictedElement.iterdescendants"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xmlparser.RestrictedElement.iterdescendants" title="Permalink to this definition"></a></dt>
<dd><p>Iterate over the descendants of this element in document order.</p>
<p>As opposed to <code class="docutils literal notranslate"><span class="pre">el.iter()</span></code>, this iterator does not yield the element
itself. The returned elements can be restricted to find only elements
with specific tags, see <cite>iter</cite>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.RestrictedElement.itersiblings">
<span class="sig-name descname"><span class="pre">itersiblings</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">tag</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">tags</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">preceding</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xmlparser.html#RestrictedElement.itersiblings"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xmlparser.RestrictedElement.itersiblings" title="Permalink to this definition"></a></dt>
<dd><p>Iterate over the following or preceding siblings of this element.</p>
<p>The direction is determined by the ‘preceding’ keyword which
defaults to False, i.e. forward iteration over the following
siblings. When True, the iterator yields the preceding
siblings in reverse document order, i.e. starting right before
the current element and going backwards.</p>
<p>Can be restricted to find only elements with specific tags,
see <cite>iter</cite>.</p>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.XML">
<span class="sig-prename descclassname"><span class="pre">onelogin.saml2.xmlparser.</span></span><span class="sig-name descname"><span class="pre">XML</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parser</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">forbid_dtd</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">forbid_entities</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#onelogin.saml2.xmlparser.XML" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.check_docinfo">
<span class="sig-prename descclassname"><span class="pre">onelogin.saml2.xmlparser.</span></span><span class="sig-name descname"><span class="pre">check_docinfo</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">elementtree</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">forbid_dtd</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">forbid_entities</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xmlparser.html#check_docinfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xmlparser.check_docinfo" title="Permalink to this definition"></a></dt>
<dd><p>Check docinfo of an element tree for DTD and entity declarations
The check for entity declarations needs lxml 3 or newer. lxml 2.x does
not support dtd.iterentities().</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.fromstring">
<span class="sig-prename descclassname"><span class="pre">onelogin.saml2.xmlparser.</span></span><span class="sig-name descname"><span class="pre">fromstring</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">text</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parser</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">forbid_dtd</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">forbid_entities</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xmlparser.html#fromstring"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xmlparser.fromstring" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.getDefaultParser">
<span class="sig-prename descclassname"><span class="pre">onelogin.saml2.xmlparser.</span></span><span class="sig-name descname"><span class="pre">getDefaultParser</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#onelogin.saml2.xmlparser.getDefaultParser" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.iterparse">
<span class="sig-prename descclassname"><span class="pre">onelogin.saml2.xmlparser.</span></span><span class="sig-name descname"><span class="pre">iterparse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xmlparser.html#iterparse"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xmlparser.iterparse" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="onelogin.saml2.xmlparser.parse">
<span class="sig-prename descclassname"><span class="pre">onelogin.saml2.xmlparser.</span></span><span class="sig-name descname"><span class="pre">parse</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">source</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">parser</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">base_url</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">forbid_dtd</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">forbid_entities</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/onelogin/saml2/xmlparser.html#parse"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#onelogin.saml2.xmlparser.parse" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</section>
<section id="module-onelogin.saml2">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-onelogin.saml2" title="Permalink to this heading"></a></h2>
<p>Add SAML support to your Python softwares using this library.</p>
<p>SAML Python toolkit let you build a SP (Service Provider)
over your Python application and connect it to any IdP (Identity Provider).</p>
<p>Supports:</p>
<ul class="simple">
<li><p>SSO and SLO (SP-Initiated and IdP-Initiated).</p></li>
<li><p>Assertion and nameId encryption.</p></li>
<li><p>Assertion signature.</p></li>
<li><p>Message signature: AuthNRequest, LogoutRequest, LogoutResponses.</p></li>
<li><p>Enable an Assertion Consumer Service endpoint.</p></li>
<li><p>Enable a Single Logout Service endpoint.</p></li>
<li><p>Publish the SP metadata (which can be signed).</p></li>
</ul>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="onelogin.html" class="btn btn-neutral float-left" title="onelogin package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2023, Sixto Martin.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
|
