Skip to content

Commit c3e696e

Browse files
committed
Minor fix on docs
1 parent cd8ea02 commit c3e696e

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -833,7 +833,7 @@ Main class of OneLogin Python Toolkit
833833
* ***get_settings*** Returns the settings info.
834834
* ***set_strict*** Set the strict mode active/disable.
835835
* ***get_last_request_xml*** Returns the most recently-constructed/processed XML SAML request (AuthNRequest, LogoutRequest)
836-
* ***get_last_response_xml*** Returns the most recently-constructed/processed XML SAML response (SAMLResponse, LogoutResponse). If the SAMLResponse was encrypted, by default tries to return the decrypted XML.
836+
* ***get_last_response_xml*** Returns the most recently-constructed/processed XML SAML response (SAMLResponse, LogoutResponse). If the SAMLResponse had an encrypted assertion, decrypts it.
837837

838838
####OneLogin_Saml2_Auth - authn_request.py####
839839

@@ -842,7 +842,7 @@ SAML 2 Authentication Request class
842842
* `__init__` This class handles an AuthNRequest. It builds an AuthNRequest object.
843843
* ***get_request*** Returns unsigned AuthnRequest.
844844
* ***get_id*** Returns the AuthNRequest ID.
845-
845+
* ***get_xml*** Returns the XML that will be sent as part of the request.
846846

847847
####OneLogin_Saml2_Response - response.py####
848848

@@ -861,6 +861,7 @@ SAML 2 Authentication Response class
861861
* ***validate_num_assertions*** Verifies that the document only contains a single Assertion (encrypted or not)
862862
* ***validate_timestamps*** Verifies that the document is valid according to Conditions Element
863863
* ***get_error*** After execute a validation process, if fails this method returns the cause
864+
* ***get_xml_document*** Returns the SAML Response document (If contains an encrypted assertion, decrypts it).
864865

865866
####OneLogin_Saml2_LogoutRequest - logout_request.py####
866867

@@ -875,6 +876,7 @@ SAML 2 Logout Request class
875876
* ***get_session_indexes*** Gets the SessionIndexes from the Logout Request.
876877
* ***is_valid*** Checks if the Logout Request recieved is valid.
877878
* ***get_error*** After execute a validation process, if fails this method returns the cause.
879+
* ***get_xml*** Returns the XML that will be sent as part of the request or that was received at the SP
878880

879881
####OneLogin_Saml2_LogoutResponse - logout_response.py####
880882

@@ -887,6 +889,7 @@ SAML 2 Logout Response class
887889
* ***build*** Creates a Logout Response object.
888890
* ***get_response*** Returns a Logout Response object.
889891
* ***get_error*** After execute a validation process, if fails this method returns the cause.
892+
* ***get_xml*** Returns the XML that will be sent as part of the response or that was received at the SP
890893

891894

892895
####OneLogin_Saml2_Settings - settings.py####

src/onelogin/saml2/response.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -793,10 +793,10 @@ def get_error(self):
793793

794794
def get_xml_document(self):
795795
"""
796-
If necessary, decrypt the XML response document, and return it.
796+
Returns the SAML Response document (If contains an encrypted assertion, decrypts it)
797797
798798
:return: Decrypted XML response document
799-
:rtype: string
799+
:rtype: DOMDocument
800800
"""
801801
if self.encrypted:
802802
return self.decrypted_document

0 commit comments

Comments
 (0)