Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

HTTP TYPEResponseURLRequestDescription
POSTSession/openId/authenticateQueryString

This method is used authenticate a user using OpenID.  Upon success, a session token will be return that can be used with most other REST calls.

After completing the OpenID

communicatoin

communication with an OpenID provider, the resulting query string returned from the OpenID provider is passed to this service.  If the query string  signature is valid and the OpenId is bound to a Synpase user the Session token will be returned (

200

201).  If the signature is not valid a 401 will be returned.  If the signature is valid but the OpenID is not bound to a user a Precondition Failed (412) will be returned.  For the latter case, see POST /openid/bind.

POSTString/openid/bindSessionToken, QueryStringBefore a user can authenticate using OpenID, the caller must first authenticate with another method and then bind the OpenID to a user providing both a valid session token and query string from the OpenId provider.POSTString/openid/bindIDSession, QueryString they must first bind their OpenID to their Synapse user account.  To bind an OpenId to an account the user must first authenticate via some other means (username/password, api key, or even another bound OpenID) to get a session token.  This is necessary to validate that a user actually wants to allow the ID to be bound to their account.  This method is idempotent. This method will return 201 for success with user's OpenID (string).
GETList<String>/openid/bindSessionTokenList the OpenIds bound to a user.  A user can only list their own OpenIDs.
DELETEBoolean/openid/bindSessionToken, OpenID (string)This call is used to "unbind" and OpenId from a user's account.  Once an OpenID is removed, the caller will no longer be able to authenticate via that OpenID.