Skip to content

Commit

Permalink
Clarify wording about auth.login in readme (#363)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
gahooa authored Jul 21, 2023
1 parent b82703f commit 888c8bc
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -677,7 +677,8 @@ req = prepare_request_for_toolkit(request)
auth = OneLogin_Saml2_Auth(req) # Constructor of the SP, loads settings.json
# and advanced_settings.json

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

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

0 comments on commit 888c8bc

Please sign in to comment.