Skip to main content

OAuth2Provider

Assembly: ServiceStack.dll​
View Source​
Declaration
public abstract class OAuth2Provider : OAuthProvider, IAuthPlugin, IOAuthProvider, IAuthProvider

Properties​

Scopes​

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

ResponseMode​

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

ResolveUnknownDisplayName​

Custom DisplayName resolver function when not provided

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

Inherited Properties​

AccessTokenUrl​

View Source​
Declaration
public string AccessTokenUrl { get; set; }

AuthHttpGateway​

View Source​
Declaration
public IAuthHttpGateway AuthHttpGateway { get; set; }

AuthorizeUrl​

View Source​
Declaration
public string AuthorizeUrl { get; set; }

ConsumerKey​

View Source​
Declaration
public string ConsumerKey { get; set; }

ConsumerSecret​

View Source​
Declaration
public string ConsumerSecret { get; set; }

IssuerSigningKeysUrl​

View Source​
Declaration
public string IssuerSigningKeysUrl { get; set; }

Meta​

View Source​
Declaration
public override Dictionary<string, string> Meta { get; }

OAuthUtils​

View Source​
Declaration
public OAuthAuthorizer OAuthUtils { get; set; }

RequestTokenUrl​

View Source​
Declaration
public string RequestTokenUrl { get; set; }

Type​

View Source​
Declaration
public override string Type { get; }

UserProfileUrl​

View Source​
Declaration
public string UserProfileUrl { get; set; }

VerifyAccessTokenAsync​

View Source​
Declaration
public Func<string, AuthContext, Task<bool>> VerifyAccessTokenAsync { get; set; }

VerifyTokenUrl​

View Source​
Declaration
public string VerifyTokenUrl { get; set; }

Methods​

AssertValidState()​

View Source​
Declaration
protected override void AssertValidState()

AssertAccessTokenUrl()​

View Source​
Declaration
protected virtual void AssertAccessTokenUrl()

AssertAuthorizeUrl()​

View Source​
Declaration
protected virtual void AssertAuthorizeUrl()

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

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

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

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

Inherited Methods​

AssertConsumerKey()​

View Source​
Declaration
protected virtual void AssertConsumerKey()

AssertConsumerSecret()​

View Source​
Declaration
protected virtual void AssertConsumerSecret()

AssertValidState()​

View Source​
Declaration
protected virtual void AssertValidState()

AuthenticateAsync(IServiceBase, IAuthSession, Authenticate, CancellationToken)​

The entry point for all AuthProvider providers. Runs inside the AuthService so exceptions are treated normally. Overridable so you can provide your own Auth implementation.

View Source​
Declaration
public abstract override 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

Init(IServiceBase, ref IAuthSession, Authenticate)​

Sets the CallbackUrl and session.ReferrerUrl if not set and initializes the session tokens for this AuthProvider

View Source​
Declaration
protected IAuthTokens Init(IServiceBase authService, ref IAuthSession session, Authenticate request)
Returns​

ServiceStack.Auth.IAuthTokens

Parameters​
TypeName
ServiceStack.IServiceBaseauthService
ServiceStack.Auth.IAuthSessionsession
ServiceStack.Authenticaterequest

IsAuthorized(IAuthSession, IAuthTokens, Authenticate)​

View Source​
Declaration
public override bool IsAuthorized(IAuthSession session, IAuthTokens tokens, Authenticate request = null)
Returns​

System.Boolean

Parameters​
TypeName
ServiceStack.Auth.IAuthSessionsession
ServiceStack.Auth.IAuthTokenstokens
ServiceStack.Authenticaterequest

LoadUserOAuthProviderAsync(IAuthSession, IAuthTokens)​

View Source​
Declaration
public virtual Task LoadUserOAuthProviderAsync(IAuthSession userSession, IAuthTokens tokens)
Returns​

System.Threading.Tasks.Task

Parameters​
TypeName
ServiceStack.Auth.IAuthSessionuserSession
ServiceStack.Auth.IAuthTokenstokens

Implements​