Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
ExistsMethodURIAuth filtered?BodyParametersReturn valueDescription

Differences

(from existing methods)

(tick)POST/session(error)LoginCredentials SessionNormal login

Does not fail if the user has not signed the terms of use. Instead, a boolean is returned along with the session token. The client can use that boolean to throw a TermsOfUseException.

Note: trying to make an authenticated request will still fail if the terms haven't been accepted.

Terms ofuse cannot be signed here.

(tick)PUT/session(error)Session  Revalidates a session token. No longer necessary, but removal will break the analytical clients.Note: This will still fail (403) if the user has not signed the terms of use.
(tick)DELETE/session(error)   Invalidated token 
(tick)POST/user(error)NewUser

sendPasswordmail=true

(Not implemented yet)

 Creates a new user

No longer goes through the auth filter. This was originally done because GET /user was filtered.

Parameter will let the client specify if Synapse should sent a "Welcome" email or a "Set your password" email.

(error)POST/user/password(error)

ChangePasswordRequest

  Changes the user's password, regardless of whether they have accepted the terms of useReplaces /changePassword and /registeringUserPassword
(error)POST/user/password/email(error)Username  Sends a password reset email (containing a session token)Replaces /registeringUserEmail, /userPasswordEmail, and /apiPasswordEmail
(error)POST/termsOfUse(error)Session  Accepts the terms of use via a session tokenNew method
(tick)GET/secretKey(tick)  SecretKeyGets the user's API key 
(tick)DELETE/secretKey(tick)   Invalidates the user's API key 
(tick)POST/openIdCallback(error) 

(OpenID params)

acceptsTermsOfUse=false

createUserIfNecessary=false

SessionLogin via OpenID, with options to create a new user and sign the terms of useTerms ofuse cannot be signed here.

...