OpenCloud
/
MatrixSynapse
mirror of https://github.com/matrix-org/synapse
1
0
Fork 0
Code Issues Releases Wiki Activity

Add a docstring to the servlet.

pull/7186/head
Patrick Cloke 2020-04-01 11:10:41 -04:00
parent b4329db27a
commit d6bbeb3890
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
synapse/rest/client/v2_alpha/auth.py
View File

@ -240,6 +240,17 @@ class AuthRestServlet(RestServlet):
class CasAuthTicketServlet(RestServlet): class CasAuthTicketServlet(RestServlet):
"""
Completes a user interactive authentication session when using CAS.
It is called after the user has completed SSO with the CAS provider and
received a ticket in response. It does the following:
* Retrieves the CAS ticket and the UI auth session from the request.
* Validates the CAS ticket.
* Marks the UI auth session as complete.
"""
PATTERNS = client_patterns(r"/auth/cas/ticket") PATTERNS = client_patterns(r"/auth/cas/ticket")
def __init__(self, hs): def __init__(self, hs):