forked from SAML-Toolkits/python3-saml
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsaml2.html
More file actions
2044 lines (1872 loc) · 122 KB
/
saml2.html
File metadata and controls
2044 lines (1872 loc) · 122 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>OneLogin saml2 Module — OneLogin SAML Python library classes and methods</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="OneLogin SAML Python library classes and methods" href="index.html" />
<link rel="prev" title="Welcome to OneLogin SAML Python library documentation" href="index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Class Index"
>modules</a> |</li>
<li class="right" >
<a href="index.html" title="Welcome to OneLogin SAML Python library documentation"
accesskey="P">previous</a> |</li>
<li><a href="index.html">OneLogin SAML Python library classes and methods</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="onelogin-saml2-package">
<h1>OneLogin saml2 Module<a class="headerlink" href="#onelogin-saml2-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-saml2.auth">
<span id="auth-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">auth</span></tt> Class<a class="headerlink" href="#module-saml2.auth" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="saml2.auth.OneLogin_Saml2_Auth">
<em class="property">class </em><tt class="descclassname">onelogin.saml2.auth.</tt><tt class="descname">OneLogin_Saml2_Auth</tt><big>(</big><em>request_data</em>, <em>old_settings=None</em><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.auth.OneLogin_Saml2_Auth" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
<dl class="method">
<dt id="saml2.auth.OneLogin_Saml2_Auth.build_request_signature">
<tt class="descname">build_request_signature</tt><big>(</big><em>saml_request</em>, <em>relay_state</em><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.build_request_signature"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.auth.OneLogin_Saml2_Auth.build_request_signature" title="Permalink to this definition">¶</a></dt>
<dd><p>Builds the Signature of the SAML Request.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>saml_request</strong> (<em>string</em>) – The SAML Request</li>
<li><strong>relay_state</strong> (<em>string</em>) – The target URL the user should be redirected to</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.auth.OneLogin_Saml2_Auth.build_response_signature">
<tt class="descname">build_response_signature</tt><big>(</big><em>saml_response</em>, <em>relay_state</em><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.build_response_signature"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.auth.OneLogin_Saml2_Auth.build_response_signature" title="Permalink to this definition">¶</a></dt>
<dd><p>Builds the Signature of the SAML Response.
:param saml_request: The SAML Response
:type saml_request: string</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>relay_state</strong> (<em>string</em>) – The target URL the user should be redirected to</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.auth.OneLogin_Saml2_Auth.get_attribute">
<tt class="descname">get_attribute</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.get_attribute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.auth.OneLogin_Saml2_Auth.get_attribute" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the requested SAML attribute.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<em>string</em>) – Name of the attribute</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Attribute value if exists or None</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">string</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.auth.OneLogin_Saml2_Auth.get_attributes">
<tt class="descname">get_attributes</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.get_attributes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.auth.OneLogin_Saml2_Auth.get_attributes" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the set of SAML attributes.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">SAML attributes</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.auth.OneLogin_Saml2_Auth.get_errors">
<tt class="descname">get_errors</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.get_errors"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">List of errors</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.auth.OneLogin_Saml2_Auth.get_last_error_reason">
<tt class="descname">get_last_error_reason</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.get_last_error_reason"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Error</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">string</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.auth.OneLogin_Saml2_Auth.get_nameid">
<tt class="descname">get_nameid</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.get_nameid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.auth.OneLogin_Saml2_Auth.get_nameid" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the nameID.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">NameID</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">string</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.auth.OneLogin_Saml2_Auth.get_settings">
<tt class="descname">get_settings</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.get_settings"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#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="method">
<dt id="saml2.auth.OneLogin_Saml2_Auth.get_slo_url">
<tt class="descname">get_slo_url</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.get_slo_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.auth.OneLogin_Saml2_Auth.get_slo_url" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the SLO url.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">An URL, the SLO endpoint of the IdP</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">string</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.auth.OneLogin_Saml2_Auth.get_sso_url">
<tt class="descname">get_sso_url</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.get_sso_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.auth.OneLogin_Saml2_Auth.get_sso_url" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the SSO url.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">An URL, the SSO endpoint of the IdP</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">string</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.auth.OneLogin_Saml2_Auth.is_authenticated">
<tt class="descname">is_authenticated</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.is_authenticated"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if is authenticated, False if not</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">bool</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.auth.OneLogin_Saml2_Auth.login">
<tt class="descname">login</tt><big>(</big><em>return_to=None</em>, <em>force_authn=False</em>, <em>is_passive=False</em><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.login"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.auth.OneLogin_Saml2_Auth.login" title="Permalink to this definition">¶</a></dt>
<dd><p>Initiates the SSO process.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>return_to</strong> (<em>string</em>) – Optional argument. The target URL the user should be redirected to after login.</li>
<li><strong>force_authn</strong> (<em>bool</em>) – Optional argument. When true the AuthNReuqest will set the ForceAuthn='true'.</li>
<li><strong>is_passive</strong> (<em>bool</em>) – Optional argument. When true the AuthNReuqest will set the Ispassive='true'.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Redirection url</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.auth.OneLogin_Saml2_Auth.logout">
<tt class="descname">logout</tt><big>(</big><em>return_to=None</em>, <em>name_id=None</em>, <em>session_index=None</em><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.logout"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.auth.OneLogin_Saml2_Auth.logout" title="Permalink to this definition">¶</a></dt>
<dd><p>Initiates the SLO process.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th>
<td class="field-body"><ul class="first simple">
<li><strong>return_to</strong> (<em>string</em>) – Optional argument. The target URL the user should be redirected to after logout.</li>
<li><strong>name_id</strong> (<em>string</em>) – Optional argument. The NameID that will be set in the LogoutRequest.</li>
<li><strong>session_index</strong> (<em>string</em>) – Optional argument. SessionIndex that identifies the session of the user.</li>
</ul></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Redirection url</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.auth.OneLogin_Saml2_Auth.process_response">
<tt class="descname">process_response</tt><big>(</big><em>request_id=None</em><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.process_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>request_id</strong> (<em>string</em>) – Is an optional argumen. Is the ID of the AuthNRequest sent by this SP to the IdP.</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises :</th><td class="field-body">OneLogin_Saml2_Error.SAML_RESPONSE_NOT_FOUND, when a POST with a SAMLResponse is not found</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.auth.OneLogin_Saml2_Auth.process_slo">
<tt class="descname">process_slo</tt><big>(</big><em>keep_local_session=False</em>, <em>request_id=None</em>, <em>delete_session_cb=None</em><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.process_slo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>keep_local_session</strong> (<em>bool</em>) – When false will destroy the local session, otherwise will destroy it</li>
<li><strong>request_id</strong> (<em>string</em>) – The ID of the LogoutRequest sent by this SP to the IdP</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Redirection url</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.auth.OneLogin_Saml2_Auth.redirect_to">
<tt class="descname">redirect_to</tt><big>(</big><em>url=None</em>, <em>parameters={}</em><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.redirect_to"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.auth.OneLogin_Saml2_Auth.redirect_to" title="Permalink to this definition">¶</a></dt>
<dd><p>Redirects the user to the url past by parameter or to the url that we defined in our SSO Request.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>url</strong> (<em>string</em>) – The target URL to redirect the user</li>
<li><strong>parameters</strong> (<em>dict</em>) – Extra parameters to be passed as part of the url</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">Redirection url</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.auth.OneLogin_Saml2_Auth.set_strict">
<tt class="descname">set_strict</tt><big>(</big><em>value</em><big>)</big><a class="reference internal" href="_modules/saml2/auth.html#OneLogin_Saml2_Auth.set_strict"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.auth.OneLogin_Saml2_Auth.set_strict" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the strict mode active/disable</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>value</strong> (<em>bool</em>) – </td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-saml2.authn_request">
<span id="authn-request-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">authn_request</span></tt> Class<a class="headerlink" href="#module-saml2.authn_request" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="saml2.authn_request.OneLogin_Saml2_Authn_Request">
<em class="property">class </em><tt class="descclassname">onelogin.saml2.authn_request.</tt><tt class="descname">OneLogin_Saml2_Authn_Request</tt><big>(</big><em>settings</em>, <em>force_authn=False</em>, <em>is_passive=False</em><big>)</big><a class="reference internal" href="_modules/saml2/authn_request.html#OneLogin_Saml2_Authn_Request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.authn_request.OneLogin_Saml2_Authn_Request" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="saml2.authn_request.OneLogin_Saml2_Authn_Request.get_request">
<tt class="descname">get_request</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/authn_request.html#OneLogin_Saml2_Authn_Request.get_request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.authn_request.OneLogin_Saml2_Authn_Request.get_request" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns unsigned AuthnRequest.
:return: Unsigned AuthnRequest
:rtype: str object</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-saml2.constants">
<span id="constants-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">constants</span></tt> Class<a class="headerlink" href="#module-saml2.constants" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="saml2.constants.OneLogin_Saml2_Constants">
<em class="property">class </em><tt class="descclassname">onelogin.saml2.constants.</tt><tt class="descname">OneLogin_Saml2_Constants</tt><a class="reference internal" href="_modules/saml2/constants.html#OneLogin_Saml2_Constants"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants" title="Permalink to this definition">¶</a></dt>
<dd><dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.AC_KERBEROS">
<tt class="descname">AC_KERBEROS</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:ac:classes:Kerberos'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.AC_KERBEROS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.AC_PASSWORD">
<tt class="descname">AC_PASSWORD</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:ac:classes:Password'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.AC_PASSWORD" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.AC_SMARTCARD">
<tt class="descname">AC_SMARTCARD</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:ac:classes:Smartcard'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.AC_SMARTCARD" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.AC_UNSPECIFIED">
<tt class="descname">AC_UNSPECIFIED</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:ac:classes:unspecified'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.AC_UNSPECIFIED" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.AC_X509">
<tt class="descname">AC_X509</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:ac:classes:X509'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.AC_X509" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.ALOWED_CLOCK_DRIFT">
<tt class="descname">ALOWED_CLOCK_DRIFT</tt><em class="property"> = 180</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.ALOWED_CLOCK_DRIFT" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.ATTRNAME_FORMAT_BASIC">
<tt class="descname">ATTRNAME_FORMAT_BASIC</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:attrname-format:basic'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.ATTRNAME_FORMAT_BASIC" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.ATTRNAME_FORMAT_UNSPECIFIED">
<tt class="descname">ATTRNAME_FORMAT_UNSPECIFIED</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.ATTRNAME_FORMAT_UNSPECIFIED" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.ATTRNAME_FORMAT_URI">
<tt class="descname">ATTRNAME_FORMAT_URI</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:attrname-format:uri'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.ATTRNAME_FORMAT_URI" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.BINDING_DEFLATE">
<tt class="descname">BINDING_DEFLATE</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:bindings:URL-Encoding:DEFLATE'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.BINDING_DEFLATE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.BINDING_HTTP_ARTIFACT">
<tt class="descname">BINDING_HTTP_ARTIFACT</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.BINDING_HTTP_ARTIFACT" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.BINDING_HTTP_POST">
<tt class="descname">BINDING_HTTP_POST</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.BINDING_HTTP_POST" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.BINDING_HTTP_REDIRECT">
<tt class="descname">BINDING_HTTP_REDIRECT</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.BINDING_HTTP_REDIRECT" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.BINDING_SOAP">
<tt class="descname">BINDING_SOAP</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:bindings:SOAP'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.BINDING_SOAP" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.CM_BEARER">
<tt class="descname">CM_BEARER</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:cm:bearer'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.CM_BEARER" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.CM_HOLDER_KEY">
<tt class="descname">CM_HOLDER_KEY</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:cm:holder-of-key'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.CM_HOLDER_KEY" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.CM_SENDER_VOUCHES">
<tt class="descname">CM_SENDER_VOUCHES</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:cm:sender-vouches'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.CM_SENDER_VOUCHES" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.NAMEID_EMAIL_ADDRESS">
<tt class="descname">NAMEID_EMAIL_ADDRESS</tt><em class="property"> = 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.NAMEID_EMAIL_ADDRESS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.NAMEID_ENCRYPTED">
<tt class="descname">NAMEID_ENCRYPTED</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:nameid-format:encrypted'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.NAMEID_ENCRYPTED" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.NAMEID_ENTITY">
<tt class="descname">NAMEID_ENTITY</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:nameid-format:entity'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.NAMEID_ENTITY" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.NAMEID_KERBEROS">
<tt class="descname">NAMEID_KERBEROS</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.NAMEID_KERBEROS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.NAMEID_PERSISTENT">
<tt class="descname">NAMEID_PERSISTENT</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:nameid-format:persistent'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.NAMEID_PERSISTENT" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.NAMEID_TRANSIENT">
<tt class="descname">NAMEID_TRANSIENT</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:nameid-format:transient'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.NAMEID_TRANSIENT" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.NAMEID_WINDOWS_DOMAIN_QUALIFIED_NAME">
<tt class="descname">NAMEID_WINDOWS_DOMAIN_QUALIFIED_NAME</tt><em class="property"> = 'urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.NAMEID_WINDOWS_DOMAIN_QUALIFIED_NAME" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.NAMEID_X509_SUBJECT_NAME">
<tt class="descname">NAMEID_X509_SUBJECT_NAME</tt><em class="property"> = 'urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.NAMEID_X509_SUBJECT_NAME" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.NSMAP">
<tt class="descname">NSMAP</tt><em class="property"> = {'xenc': 'http://www.w3.org/2001/04/xmlenc#', 'samlp': 'urn:oasis:names:tc:SAML:2.0:protocol', 'ds': 'http://www.w3.org/2000/09/xmldsig#', 'saml': 'urn:oasis:names:tc:SAML:2.0:assertion'}</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.NSMAP" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.NS_DS">
<tt class="descname">NS_DS</tt><em class="property"> = 'http://www.w3.org/2000/09/xmldsig#'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.NS_DS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.NS_MD">
<tt class="descname">NS_MD</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:metadata'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.NS_MD" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.NS_SAML">
<tt class="descname">NS_SAML</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:assertion'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.NS_SAML" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.NS_SAMLP">
<tt class="descname">NS_SAMLP</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:protocol'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.NS_SAMLP" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.NS_SOAP">
<tt class="descname">NS_SOAP</tt><em class="property"> = 'http://schemas.xmlsoap.org/soap/envelope/'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.NS_SOAP" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.NS_XENC">
<tt class="descname">NS_XENC</tt><em class="property"> = 'http://www.w3.org/2001/04/xmlenc#'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.NS_XENC" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.NS_XS">
<tt class="descname">NS_XS</tt><em class="property"> = 'http://www.w3.org/2001/XMLSchema'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.NS_XS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.NS_XSI">
<tt class="descname">NS_XSI</tt><em class="property"> = 'http://www.w3.org/2001/XMLSchema-instance'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.NS_XSI" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.RSA_SHA1">
<tt class="descname">RSA_SHA1</tt><em class="property"> = 'http://www.w3.org/2000/09/xmldsig#rsa-sha1'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.RSA_SHA1" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.STATUS_NO_PASSIVE">
<tt class="descname">STATUS_NO_PASSIVE</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:status:NoPassive'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.STATUS_NO_PASSIVE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.STATUS_PARTIAL_LOGOUT">
<tt class="descname">STATUS_PARTIAL_LOGOUT</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:status:PartialLogout'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.STATUS_PARTIAL_LOGOUT" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.STATUS_PROXY_COUNT_EXCEEDED">
<tt class="descname">STATUS_PROXY_COUNT_EXCEEDED</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:status:ProxyCountExceeded'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.STATUS_PROXY_COUNT_EXCEEDED" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.STATUS_REQUESTER">
<tt class="descname">STATUS_REQUESTER</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:status:Requester'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.STATUS_REQUESTER" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.STATUS_RESPONDER">
<tt class="descname">STATUS_RESPONDER</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:status:Responder'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.STATUS_RESPONDER" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.STATUS_SUCCESS">
<tt class="descname">STATUS_SUCCESS</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:status:Success'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.STATUS_SUCCESS" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.constants.OneLogin_Saml2_Constants.STATUS_VERSION_MISMATCH">
<tt class="descname">STATUS_VERSION_MISMATCH</tt><em class="property"> = 'urn:oasis:names:tc:SAML:2.0:status:VersionMismatch'</em><a class="headerlink" href="#saml2.constants.OneLogin_Saml2_Constants.STATUS_VERSION_MISMATCH" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-saml2.errors">
<span id="errors-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">errors</span></tt> Class<a class="headerlink" href="#module-saml2.errors" title="Permalink to this headline">¶</a></h2>
<dl class="exception">
<dt id="saml2.errors.OneLogin_Saml2_Error">
<em class="property">exception </em><tt class="descclassname">onelogin.saml2.errors.</tt><tt class="descname">OneLogin_Saml2_Error</tt><big>(</big><em>message</em>, <em>code=0</em>, <em>errors=None</em><big>)</big><a class="reference internal" href="_modules/saml2/errors.html#OneLogin_Saml2_Error"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.errors.OneLogin_Saml2_Error" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></tt></p>
<dl class="attribute">
<dt id="saml2.errors.OneLogin_Saml2_Error.METADATA_SP_INVALID">
<tt class="descname">METADATA_SP_INVALID</tt><em class="property"> = 3</em><a class="headerlink" href="#saml2.errors.OneLogin_Saml2_Error.METADATA_SP_INVALID" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.errors.OneLogin_Saml2_Error.PRIVATE_KEY_FILE_NOT_FOUND">
<tt class="descname">PRIVATE_KEY_FILE_NOT_FOUND</tt><em class="property"> = 7</em><a class="headerlink" href="#saml2.errors.OneLogin_Saml2_Error.PRIVATE_KEY_FILE_NOT_FOUND" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.errors.OneLogin_Saml2_Error.PUBLIC_CERT_FILE_NOT_FOUND">
<tt class="descname">PUBLIC_CERT_FILE_NOT_FOUND</tt><em class="property"> = 6</em><a class="headerlink" href="#saml2.errors.OneLogin_Saml2_Error.PUBLIC_CERT_FILE_NOT_FOUND" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.errors.OneLogin_Saml2_Error.REDIRECT_INVALID_URL">
<tt class="descname">REDIRECT_INVALID_URL</tt><em class="property"> = 5</em><a class="headerlink" href="#saml2.errors.OneLogin_Saml2_Error.REDIRECT_INVALID_URL" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.errors.OneLogin_Saml2_Error.SAML_LOGOUTMESSAGE_NOT_FOUND">
<tt class="descname">SAML_LOGOUTMESSAGE_NOT_FOUND</tt><em class="property"> = 9</em><a class="headerlink" href="#saml2.errors.OneLogin_Saml2_Error.SAML_LOGOUTMESSAGE_NOT_FOUND" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.errors.OneLogin_Saml2_Error.SAML_LOGOUTREQUEST_INVALID">
<tt class="descname">SAML_LOGOUTREQUEST_INVALID</tt><em class="property"> = 10</em><a class="headerlink" href="#saml2.errors.OneLogin_Saml2_Error.SAML_LOGOUTREQUEST_INVALID" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.errors.OneLogin_Saml2_Error.SAML_LOGOUTRESPONSE_INVALID">
<tt class="descname">SAML_LOGOUTRESPONSE_INVALID</tt><em class="property"> = 11</em><a class="headerlink" href="#saml2.errors.OneLogin_Saml2_Error.SAML_LOGOUTRESPONSE_INVALID" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.errors.OneLogin_Saml2_Error.SAML_RESPONSE_NOT_FOUND">
<tt class="descname">SAML_RESPONSE_NOT_FOUND</tt><em class="property"> = 8</em><a class="headerlink" href="#saml2.errors.OneLogin_Saml2_Error.SAML_RESPONSE_NOT_FOUND" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.errors.OneLogin_Saml2_Error.SAML_SINGLE_LOGOUT_NOT_SUPPORTED">
<tt class="descname">SAML_SINGLE_LOGOUT_NOT_SUPPORTED</tt><em class="property"> = 12</em><a class="headerlink" href="#saml2.errors.OneLogin_Saml2_Error.SAML_SINGLE_LOGOUT_NOT_SUPPORTED" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.errors.OneLogin_Saml2_Error.SETTINGS_FILE_NOT_FOUND">
<tt class="descname">SETTINGS_FILE_NOT_FOUND</tt><em class="property"> = 0</em><a class="headerlink" href="#saml2.errors.OneLogin_Saml2_Error.SETTINGS_FILE_NOT_FOUND" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.errors.OneLogin_Saml2_Error.SETTINGS_INVALID">
<tt class="descname">SETTINGS_INVALID</tt><em class="property"> = 2</em><a class="headerlink" href="#saml2.errors.OneLogin_Saml2_Error.SETTINGS_INVALID" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.errors.OneLogin_Saml2_Error.SETTINGS_INVALID_SYNTAX">
<tt class="descname">SETTINGS_INVALID_SYNTAX</tt><em class="property"> = 1</em><a class="headerlink" href="#saml2.errors.OneLogin_Saml2_Error.SETTINGS_INVALID_SYNTAX" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.errors.OneLogin_Saml2_Error.SP_CERTS_NOT_FOUND">
<tt class="descname">SP_CERTS_NOT_FOUND</tt><em class="property"> = 4</em><a class="headerlink" href="#saml2.errors.OneLogin_Saml2_Error.SP_CERTS_NOT_FOUND" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
<div class="section" id="module-saml2.logout_request">
<span id="logout-request-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">logout_request</span></tt> Class<a class="headerlink" href="#module-saml2.logout_request" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="saml2.logout_request.OneLogin_Saml2_Logout_Request">
<em class="property">class </em><tt class="descclassname">onelogin.saml2.logout_request.</tt><tt class="descname">OneLogin_Saml2_Logout_Request</tt><big>(</big><em>settings</em>, <em>request=None</em>, <em>name_id=None</em>, <em>session_index=None</em><big>)</big><a class="reference internal" href="_modules/saml2/logout_request.html#OneLogin_Saml2_Logout_Request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.logout_request.OneLogin_Saml2_Logout_Request" title="Permalink to this definition">¶</a></dt>
<dd><dl class="staticmethod">
<dt id="saml2.logout_request.OneLogin_Saml2_Logout_Request.get_id">
<em class="property">static </em><tt class="descname">get_id</tt><big>(</big><em>request</em><big>)</big><a class="reference internal" href="_modules/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.get_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#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="staticmethod">
<dt id="saml2.logout_request.OneLogin_Saml2_Logout_Request.get_issuer">
<em class="property">static </em><tt class="descname">get_issuer</tt><big>(</big><em>request</em><big>)</big><a class="reference internal" href="_modules/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.get_issuer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#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="staticmethod">
<dt id="saml2.logout_request.OneLogin_Saml2_Logout_Request.get_name_id">
<em class="property">static </em><tt class="descname">get_name_id</tt><big>(</big><em>request</em>, <em>key=None</em><big>)</big><a class="reference internal" href="_modules/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.get_name_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.logout_request.OneLogin_Saml2_Logout_Request.get_name_id" 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="staticmethod">
<dt id="saml2.logout_request.OneLogin_Saml2_Logout_Request.get_name_id_data">
<em class="property">static </em><tt class="descname">get_name_id_data</tt><big>(</big><em>request</em>, <em>key=None</em><big>)</big><a class="reference internal" href="_modules/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.get_name_id_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.logout_request.OneLogin_Saml2_Logout_Request.get_name_id_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="method">
<dt id="saml2.logout_request.OneLogin_Saml2_Logout_Request.get_request">
<tt class="descname">get_request</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.get_request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.logout_request.OneLogin_Saml2_Logout_Request.get_request" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the Logout Request defated, base64encoded
:return: Deflated base64 encoded Logout Request
:rtype: str object</p>
</dd></dl>
<dl class="staticmethod">
<dt id="saml2.logout_request.OneLogin_Saml2_Logout_Request.get_session_indexes">
<em class="property">static </em><tt class="descname">get_session_indexes</tt><big>(</big><em>request</em><big>)</big><a class="reference internal" href="_modules/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.get_session_indexes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#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="staticmethod">
<dt id="saml2.logout_request.OneLogin_Saml2_Logout_Request.is_valid">
<em class="property">static </em><tt class="descname">is_valid</tt><big>(</big><em>settings</em>, <em>request</em>, <em>get_data</em>, <em>debug=False</em><big>)</big><a class="reference internal" href="_modules/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.is_valid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.logout_request.OneLogin_Saml2_Logout_Request.is_valid" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks if the Logout Request recieved is valid
:param settings: Settings
:type settings: OneLogin_Saml2_Settings
:param request: Logout Request Message
:type request: string|DOMDocument
:return: If the Logout Request is or not valid
:rtype: boolean</p>
</dd></dl>
<dl class="method">
<dt id="saml2.logout_request.OneLogin_Saml2_Logout_Request.get_error">
<tt class="descname">get_error</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/logout_request.html#OneLogin_Saml2_Logout_Request.get_request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.logout_request.OneLogin_Saml2_Logout_Request.get_error" title="Permalink to this definition">¶</a></dt>
<dd><p>After execute a validation process, if fails this method returns the cause
:rtype: str object</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-saml2.logout_response">
<span id="logout-response-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">logout_response</span></tt> Class<a class="headerlink" href="#module-saml2.logout_response" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="saml2.logout_response.OneLogin_Saml2_Logout_Response">
<em class="property">class </em><tt class="descclassname">onelogin.saml2.logout_response.</tt><tt class="descname">OneLogin_Saml2_Logout_Response</tt><big>(</big><em>settings</em>, <em>response=None</em><big>)</big><a class="reference internal" href="_modules/saml2/logout_response.html#OneLogin_Saml2_Logout_Response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.logout_response.OneLogin_Saml2_Logout_Response" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="saml2.logout_response.OneLogin_Saml2_Logout_Response.build">
<tt class="descname">build</tt><big>(</big><em>in_response_to</em><big>)</big><a class="reference internal" href="_modules/saml2/logout_response.html#OneLogin_Saml2_Logout_Response.build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#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</p>
</dd></dl>
<dl class="method">
<dt id="saml2.logout_response.OneLogin_Saml2_Logout_Response.get_issuer">
<tt class="descname">get_issuer</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/logout_response.html#OneLogin_Saml2_Logout_Response.get_issuer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#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="method">
<dt id="saml2.logout_response.OneLogin_Saml2_Logout_Response.get_response">
<tt class="descname">get_response</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/logout_response.html#OneLogin_Saml2_Logout_Response.get_response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.logout_response.OneLogin_Saml2_Logout_Response.get_response" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a Logout Response object.
:return: Logout Response deflated and base64 encoded
:rtype: string</p>
</dd></dl>
<dl class="method">
<dt id="saml2.logout_response.OneLogin_Saml2_Logout_Response.get_status">
<tt class="descname">get_status</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/logout_response.html#OneLogin_Saml2_Logout_Response.get_status"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#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="method">
<dt id="saml2.logout_response.OneLogin_Saml2_Logout_Response.is_valid">
<tt class="descname">is_valid</tt><big>(</big><em>request_data</em>, <em>request_id=None</em><big>)</big><a class="reference internal" href="_modules/saml2/logout_response.html#OneLogin_Saml2_Logout_Response.is_valid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#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
:return: Returns if the SAML LogoutResponse is or not valid
:rtype: boolean</p>
</dd></dl>
<dl class="method">
<dt id="saml2.logout_response.OneLogin_Saml2_Logout_Response.get_error">
<tt class="descname">get_error</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/logout_response.html#OneLogin_Saml2_Logout_Response.get_request"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.logout_response.OneLogin_Saml2_Logout_Response.get_error" title="Permalink to this definition">¶</a></dt>
<dd><p>After execute a validation process, if fails this method returns the cause
:rtype: str object</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-saml2.metadata">
<span id="metadata-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">metadata</span></tt> Class<a class="headerlink" href="#module-saml2.metadata" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="saml2.metadata.OneLogin_Saml2_Metadata">
<em class="property">class </em><tt class="descclassname">onelogin.saml2.metadata.</tt><tt class="descname">OneLogin_Saml2_Metadata</tt><a class="reference internal" href="_modules/saml2/metadata.html#OneLogin_Saml2_Metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.metadata.OneLogin_Saml2_Metadata" title="Permalink to this definition">¶</a></dt>
<dd><dl class="attribute">
<dt id="saml2.metadata.OneLogin_Saml2_Metadata.TIME_CACHED">
<tt class="descname">TIME_CACHED</tt><em class="property"> = 604800</em><a class="headerlink" href="#saml2.metadata.OneLogin_Saml2_Metadata.TIME_CACHED" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="saml2.metadata.OneLogin_Saml2_Metadata.TIME_VALID">
<tt class="descname">TIME_VALID</tt><em class="property"> = 172800</em><a class="headerlink" href="#saml2.metadata.OneLogin_Saml2_Metadata.TIME_VALID" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="saml2.metadata.OneLogin_Saml2_Metadata.add_x509_key_descriptors">
<em class="property">static </em><tt class="descname">add_x509_key_descriptors</tt><big>(</big><em>metadata</em>, <em>cert</em><big>)</big><a class="reference internal" href="_modules/saml2/metadata.html#OneLogin_Saml2_Metadata.add_x509_key_descriptors"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.metadata.OneLogin_Saml2_Metadata.add_x509_key_descriptors" title="Permalink to this definition">¶</a></dt>
<dd><p>Add the x509 descriptors (sign/encriptation to the metadata
The same cert will be used for sign/encrypt</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>metadata</strong> (<em>string</em>) – SAML Metadata XML</li>
<li><strong>cert</strong> (<em>string</em>) – x509 cert</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Metadata with KeyDescriptors</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="staticmethod">
<dt id="saml2.metadata.OneLogin_Saml2_Metadata.builder">
<em class="property">static </em><tt class="descname">builder</tt><big>(</big><em>sp</em>, <em>authnsign=False</em>, <em>wsign=False</em>, <em>valid_until=None</em>, <em>cache_duration=None</em>, <em>contacts=None</em>, <em>organization=None</em><big>)</big><a class="reference internal" href="_modules/saml2/metadata.html#OneLogin_Saml2_Metadata.builder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.metadata.OneLogin_Saml2_Metadata.builder" title="Permalink to this definition">¶</a></dt>
<dd><p>Build the metadata of the SP</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>sp</strong> (<em>string</em>) – The SP data</li>
<li><strong>authnsign</strong> (<em>string</em>) – authnRequestsSigned attribute</li>
<li><strong>wsign</strong> (<em>string</em>) – wantAssertionsSigned attribute</li>
<li><strong>valid_until</strong> (<em>DateTime</em>) – Metadata’s valid time</li>
<li><strong>cache_duration</strong> (<em>Timestamp</em>) – Duration of the cache in seconds</li>
<li><strong>contacts</strong> (<em>dict</em>) – Contacts info</li>
<li><strong>organization</strong> (<em>dict</em>) – Organization ingo</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="staticmethod">
<dt id="saml2.metadata.OneLogin_Saml2_Metadata.sign_metadata">
<em class="property">static </em><tt class="descname">sign_metadata</tt><big>(</big><em>metadata</em>, <em>key</em>, <em>cert</em><big>)</big><a class="reference internal" href="_modules/saml2/metadata.html#OneLogin_Saml2_Metadata.sign_metadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.metadata.OneLogin_Saml2_Metadata.sign_metadata" title="Permalink to this definition">¶</a></dt>
<dd><p>Sign the metadata with the key/cert provided</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>metadata</strong> (<em>string</em>) – SAML Metadata XML</li>
<li><strong>key</strong> (<em>string</em>) – x509 key</li>
<li><strong>cert</strong> (<em>string</em>) – x509 cert</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">Signed Metadata</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">string</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="module-saml2.response">
<span id="response-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">response</span></tt> Class<a class="headerlink" href="#module-saml2.response" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="saml2.response.OneLogin_Saml2_Response">
<em class="property">class </em><tt class="descclassname">onelogin.saml2.response.</tt><tt class="descname">OneLogin_Saml2_Response</tt><big>(</big><em>settings</em>, <em>response</em><big>)</big><a class="reference internal" href="_modules/saml2/response.html#OneLogin_Saml2_Response"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.response.OneLogin_Saml2_Response" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">object</span></tt></p>
<dl class="method">
<dt id="saml2.response.OneLogin_Saml2_Response.check_status">
<tt class="descname">check_status</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/response.html#OneLogin_Saml2_Response.check_status"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Raises :</th><td class="field-body">Exception. If the status is not success</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.response.OneLogin_Saml2_Response.get_attributes">
<tt class="descname">get_attributes</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/response.html#OneLogin_Saml2_Response.get_attributes"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#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="method">
<dt id="saml2.response.OneLogin_Saml2_Response.get_audiences">
<tt class="descname">get_audiences</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/response.html#OneLogin_Saml2_Response.get_audiences"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#saml2.response.OneLogin_Saml2_Response.get_audiences" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets the audiences</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The valid audiences for the SAML Response</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.response.OneLogin_Saml2_Response.get_issuers">
<tt class="descname">get_issuers</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/response.html#OneLogin_Saml2_Response.get_issuers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The issuers</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.response.OneLogin_Saml2_Response.get_nameid">
<tt class="descname">get_nameid</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/response.html#OneLogin_Saml2_Response.get_nameid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">NameID (value)</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">string</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.response.OneLogin_Saml2_Response.get_nameid_data">
<tt class="descname">get_nameid_data</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/response.html#OneLogin_Saml2_Response.get_nameid_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Name ID Data (Value, Format, NameQualifier, SPNameQualifier)</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="saml2.response.OneLogin_Saml2_Response.get_session_index">
<tt class="descname">get_session_index</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/saml2/response.html#OneLogin_Saml2_Response.get_session_index"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#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>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The SessionIndex value</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">string|None</td>
</tr>