OAuthSettings

Settings for an OAuth 2.0 client application.

One client application may hold multiple settings objects when using various authentication servers.

Instances of this class must be immutable.

@safe

class OAuthSettings {

OAuthProvider provider;

string clientId;

string clientSecret;

string redirectUri;

ubyte[] hash;

this(Json config);

this(string provider, string clientId, string clientSecret, string redirectUri);

string userAuthUri(Session httpSession, string[string] extraParams, string[] scopes);

string userAuthUri(Session httpSession, string[] scopes);

OAuthSession userSession(Session httpSession, string state, string authorizationCode);

OAuthSession userSession(string username, string password, string[] scopes);

OAuthSession clientSession(string[] scopes);

OAuthSession loadSession(Session httpSession);

}

Constructors

this this(Json config): Construct OAuthSettings from JSON object.
this this(string provider, string clientId, string clientSecret, string redirectUri): Construct OAuthSettings providing settings directly.

Members

Functions

clientSession OAuthSession clientSession(string[] scopes): Obtain a new session using client credentials.
loadSession deprecated OAuthSession loadSession(Session httpSession): Undocumented in source. Be warned that the author may not have intended to support it.
userAuthUri string userAuthUri(Session httpSession, string[string] extraParams, string[] scopes)
string userAuthUri(Session httpSession, string[] scopes): User login helper method.
userSession OAuthSession userSession(Session httpSession, string state, string authorizationCode): User login helper method, complementary to userAuthUri.
userSession OAuthSession userSession(string username, string password, string[] scopes): Start a session on behalf of the resource owner, using _username and _password for authentication.

Variables

clientId string clientId;
clientSecret string clientSecret;
hash ubyte[] hash;: Undocumented in source.
provider OAuthProvider provider;
redirectUri string redirectUri;

Meta

Source

See Implementation

oauth settings classes

OAuthSettings

functions

loadConfig