Skip to main content

GoogleAuthProvider

Create an OAuth2 App at: https://code.google.com/apis/console/ The Apps Callback URL should match the CallbackUrl here. Google OAuth2 info: https://developers.google.com/accounts/docs/OAuth2Login Google OAuth2 Scopes from: https://www.googleapis.com/discovery/v1/apis/oauth2/v2/rest?fields=auth(oauth2(scopes)) https://www.googleapis.com/auth/plus.login: Know your name, basic info, and list of people you're connected to on Google+ https://www.googleapis.com/auth/plus.me Know who you are on Google+ https://www.googleapis.com/auth/userinfo.email View your email address https://www.googleapis.com/auth/userinfo.profile View basic information about your account

Assembly: ServiceStack.dll
View Source
Declaration
public class GoogleAuthProvider : OAuth2Provider, IAuthPlugin, IOAuthProvider, IAuthProvider

Inherited Properties

ResolveUnknownDisplayName

Custom DisplayName resolver function when not provided

View Source
Declaration
public Func<IAuthSession, IAuthTokens, string> ResolveUnknownDisplayName { get; set; }

ResponseMode

View Source
Declaration
public string ResponseMode { get; set; }

Scopes

View Source
Declaration
public string[] Scopes { get; set; }

Fields

Name

View Source
Declaration
public const string Name = "google"

Realm

View Source
Declaration
public static string Realm

DefaultAuthorizeUrl

View Source
Declaration
public const string DefaultAuthorizeUrl = "https://accounts.google.com/o/oauth2/v2/auth"

DefaultAccessTokenUrl

View Source
Declaration
public const string DefaultAccessTokenUrl = "https://oauth2.googleapis.com/token"

DefaultUserProfileUrl

View Source
Declaration
public const string DefaultUserProfileUrl = "https://www.googleapis.com/oauth2/v2/userinfo"

DefaultVerifyTokenUrl

View Source
Declaration
public const string DefaultVerifyTokenUrl = "https://www.googleapis.com/oauth2/v2/tokeninfo?access_token={0}"

Methods

OnVerifyAccessTokenAsync(String, AuthContext)

View Source
Declaration
public virtual async Task<bool> OnVerifyAccessTokenAsync(string accessToken, AuthContext ctx)
Returns

System.Threading.Tasks.Task<System.Boolean>

Parameters
TypeName
System.StringaccessToken
ServiceStack.Auth.AuthContextctx

AuthenticateWithAccessTokenAsync(IServiceBase, IAuthSession, IAuthTokens, String, Dictionary<String, String>, CancellationToken)

View Source
Declaration
protected override async Task<object> AuthenticateWithAccessTokenAsync(IServiceBase authService, IAuthSession session, IAuthTokens tokens, string accessToken, Dictionary<string, string> authInfo = null, CancellationToken token = default(CancellationToken))
Returns

System.Threading.Tasks.Task<System.Object>

Parameters
TypeName
ServiceStack.IServiceBaseauthService
ServiceStack.Auth.IAuthSessionsession
ServiceStack.Auth.IAuthTokenstokens
System.StringaccessToken
System.Collections.Generic.Dictionary<System.String,System.String>authInfo
System.Threading.CancellationTokentoken

CreateAuthInfoAsync(String, CancellationToken)

View Source
Declaration
protected override async Task<Dictionary<string, string>> CreateAuthInfoAsync(string accessToken, CancellationToken token = default(CancellationToken))
Returns

System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<System.String,System.String>>

Parameters
TypeName
System.StringaccessToken
System.Threading.CancellationTokentoken

Inherited Methods

AssertAccessTokenUrl()

View Source
Declaration
protected virtual void AssertAccessTokenUrl()

AssertAuthorizeUrl()

View Source
Declaration
protected virtual void AssertAuthorizeUrl()

AssertValidState()

View Source
Declaration
protected override void AssertValidState()

AuthenticateAsync(IServiceBase, IAuthSession, Authenticate, CancellationToken)

View Source
Declaration
public override async Task<object> AuthenticateAsync(IServiceBase authService, IAuthSession session, Authenticate request, CancellationToken token = default(CancellationToken))
Returns

System.Threading.Tasks.Task<System.Object>

Parameters
TypeName
ServiceStack.IServiceBaseauthService
ServiceStack.Auth.IAuthSessionsession
ServiceStack.Authenticaterequest
System.Threading.CancellationTokentoken

AuthenticateWithAccessTokenAsync(IServiceBase, IAuthSession, IAuthTokens, String, Dictionary<String, String>, CancellationToken)

View Source
Declaration
protected virtual async Task<object> AuthenticateWithAccessTokenAsync(IServiceBase authService, IAuthSession session, IAuthTokens tokens, string accessToken, Dictionary<string, string> authInfo = null, CancellationToken token = default(CancellationToken))
Returns

System.Threading.Tasks.Task<System.Object>

Parameters
TypeName
ServiceStack.IServiceBaseauthService
ServiceStack.Auth.IAuthSessionsession
ServiceStack.Auth.IAuthTokenstokens
System.StringaccessToken
System.Collections.Generic.Dictionary<System.String,System.String>authInfo
System.Threading.CancellationTokentoken

CreateAuthInfoAsync(String, CancellationToken)

View Source
Declaration
protected abstract Task<Dictionary<string, string>> CreateAuthInfoAsync(string accessToken, CancellationToken token = default(CancellationToken))
Returns

System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<System.String,System.String>>

Parameters
TypeName
System.StringaccessToken
System.Threading.CancellationTokentoken

GetAccessTokenJsonAsync(String, AuthContext, CancellationToken)

View Source
Declaration
protected virtual async Task<string> GetAccessTokenJsonAsync(string code, AuthContext ctx, CancellationToken token = default(CancellationToken))
Returns

System.Threading.Tasks.Task<System.String>

Parameters
TypeName
System.Stringcode
ServiceStack.Auth.AuthContextctx
System.Threading.CancellationTokentoken

GetUserAuthName(IAuthTokens, Dictionary<String, String>)

Override to return User chosen username or Email for this AuthProvider

View Source
Declaration
protected virtual string GetUserAuthName(IAuthTokens tokens, Dictionary<string, string> authInfo)
Returns

System.String

Parameters
TypeName
ServiceStack.Auth.IAuthTokenstokens
System.Collections.Generic.Dictionary<System.String,System.String>authInfo

LoadUserAuthInfoAsync(AuthUserSession, IAuthTokens, Dictionary<String, String>, CancellationToken)

View Source
Declaration
protected override Task LoadUserAuthInfoAsync(AuthUserSession userSession, IAuthTokens tokens, Dictionary<string, string> authInfo, CancellationToken token = default(CancellationToken))
Returns

System.Threading.Tasks.Task

Parameters
TypeName
ServiceStack.AuthUserSessionuserSession
ServiceStack.Auth.IAuthTokenstokens
System.Collections.Generic.Dictionary<System.String,System.String>authInfo
System.Threading.CancellationTokentoken

LoadUserOAuthProviderAsync(IAuthSession, IAuthTokens)

View Source
Declaration
public override Task LoadUserOAuthProviderAsync(IAuthSession authSession, IAuthTokens tokens)
Returns

System.Threading.Tasks.Task

Parameters
TypeName
ServiceStack.Auth.IAuthSessionauthSession
ServiceStack.Auth.IAuthTokenstokens

Implements