Skip to content

Commit 888c8bc

Browse files
authored
Clarify wording about auth.login in readme (#363)
The previous wording indicated that auth.login() would take some action, whereas it really just returns a URL for you to do something with (redirect or print out). This clarifies that.
1 parent b82703f commit 888c8bc

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -677,7 +677,8 @@ req = prepare_request_for_toolkit(request)
677677
auth = OneLogin_Saml2_Auth(req) # Constructor of the SP, loads settings.json
678678
# and advanced_settings.json
679679

680-
auth.login() # Method that builds and sends the AuthNRequest
680+
auth.login() # This method will build and return a AuthNRequest URL that can be
681+
# either redirected to, or printed out onto the screen as a hyperlink
681682
```
682683

683684
The ``AuthNRequest`` will be sent signed or unsigned based on the security info of the ``advanced_settings.json`` file (i.e. ``authnRequestsSigned``).

0 commit comments

Comments
 (0)