OAuthSettings.userSession

User login helper method, complementary to userAuthUri.

Use this method to start a session with user impersonation. The authorizationCode MUST be obtained by redirection of the user agent to an URI obtained through userAuthUri, otherwise there would not be a valid state.

OAuthSession userSession(Session httpSession, string state, string authorizationCode)
class OAuthSettings
final immutable
OAuthSession
userSession
(
scope Session httpSession
,
string state
,
string authorizationCode
)
out (result) { assert (result !is null); }
OAuthSession userSession(string username, string password, string[] scopes)

Parameters

httpSession Session: The current HTTP session.
state string: OAuth state obtained from the '_state' query string parameter of the request URL.
authorizationCode string: the authorization code obtained from the service. It will be in the 'code' parameter in the query string of the request being processed.

Return Value

Type: OAuthSession

The new session.

Throws

OAuthException if any of the latter two arguments is invalid or authentication fails otherwise.

OAuthSettings.userSession

Parameters

Return Value

Throws

Meta

Source