Skip to main content

AuthenticateService

Assembly: ServiceStack.dll​
View Source​
Declaration
[DefaultRequest(typeof(Authenticate))]
[ErrorView("ErrorView")]
public class AuthenticateService : Service, IService, IServiceBase, IRequiresRequest, IResolver, IDisposable, IServiceFilters, IServiceBeforeFilter, IServiceAfterFilter, IServiceErrorFilter

Properties​

CurrentSessionFactory​

View Source​
Declaration
public static Func<IAuthSession> CurrentSessionFactory { get; set; }

ValidateFn​

View Source​
Declaration
public static ValidateFn ValidateFn { get; set; }

DefaultOAuthProvider​

View Source​
Declaration
public static string DefaultOAuthProvider { get; }

DefaultOAuthRealm​

View Source​
Declaration
public static string DefaultOAuthRealm { get; }

HtmlRedirect​

View Source​
Declaration
public static string HtmlRedirect { get; }

HtmlRedirectAccessDenied​

View Source​
Declaration
public static string HtmlRedirectAccessDenied { get; }

HtmlRedirectReturnParam​

View Source​
Declaration
public static string HtmlRedirectReturnParam { get; }

HtmlRedirectReturnPathOnly​

View Source​
Declaration
public static bool HtmlRedirectReturnPathOnly { get; }

AuthResponseDecorator​

View Source​
Declaration
public static Func<AuthFilterContext, object> AuthResponseDecorator { get; }

Inherited Properties​

AuthRepository​

View Source​
Declaration
public virtual IAuthRepository AuthRepository { get; }

AuthRepositoryAsync​

View Source​
Declaration
public virtual IAuthRepositoryAsync AuthRepositoryAsync { get; }

Cache​

View Source​
Declaration
public virtual ICacheClient Cache { get; }

CacheAsync​

View Source​
Declaration
public virtual ICacheClientAsync CacheAsync { get; }

Db​

View Source​
Declaration
public virtual IDbConnection Db { get; }

Gateway​

View Source​
Declaration
public virtual IServiceGateway Gateway { get; }

GlobalResolver​

View Source​
Declaration
public static IResolver GlobalResolver { get; set; }

IsAuthenticated​

If user found in session for this request is authenticated.

View Source​
Declaration
public virtual bool IsAuthenticated { get; }

LocalCache​

Returns ServiceStack.Caching.MemoryCacheClient. cache is only persisted for this running app instance.

View Source​
Declaration
public virtual MemoryCacheClient LocalCache { get; }

MessageProducer​

View Source​
Declaration
public virtual IMessageProducer MessageProducer { get; }

Redis​

View Source​
Declaration
public virtual IRedisClient Redis { get; }

Request​

View Source​
Declaration
public IRequest Request { get; set; }

Response​

View Source​
Declaration
protected virtual IResponse Response { get; }

SessionBag​

View Source​
Declaration
public virtual ISession SessionBag { get; }

SessionBagAsync​

View Source​
Declaration
public virtual ISessionAsync SessionBagAsync { get; }

SessionFactory​

View Source​
Declaration
public virtual ISessionFactory SessionFactory { get; }

VirtualFiles​

Read/Write Virtual FileSystem. Defaults to FileSystemVirtualPathProvider

View Source​
Declaration
public IVirtualFiles VirtualFiles { get; }

VirtualFileSources​

Cascading collection of virtual file sources, inc. Embedded Resources, File System, In Memory, S3

View Source​
Declaration
public IVirtualPathProvider VirtualFileSources { get; }

Fields​

BasicProvider​

View Source​
Declaration
public const string BasicProvider = "basic"

ApiKeyProvider​

View Source​
Declaration
public const string ApiKeyProvider = "apikey"

JwtProvider​

View Source​
Declaration
public const string JwtProvider = "jwt"

CredentialsProvider​

View Source​
Declaration
public const string CredentialsProvider = "credentials"

WindowsAuthProvider​

View Source​
Declaration
public const string WindowsAuthProvider = "windowsauth"

CredentialsAliasProvider​

View Source​
Declaration
public const string CredentialsAliasProvider = "login"

LogoutAction​

View Source​
Declaration
public const string LogoutAction = "logout"

DigestProvider​

View Source​
Declaration
public const string DigestProvider = "digest"

IdentityProvider​

View Source​
Declaration
public const string IdentityProvider = "identity"

Methods​

GetAuthProviders(String)​

Get AuthProviders Registered in AuthFeature Plugin.

View Source​
Declaration
public static IAuthProvider[] GetAuthProviders(string provider = null)
Returns​

ServiceStack.Auth.IAuthProvider[]

Parameters​
TypeNameDescription
System.Stringproviderspecific provider, or null for all providers

|

GetUserSessionSource()​

View Source​
Declaration
[Obsolete("Use GetUserSessionSourceAsync()")]
public static IUserSessionSource GetUserSessionSource()
Returns​

ServiceStack.Auth.IUserSessionSource

GetUserSessionSourceAsync()​

View Source​
Declaration
public static IUserSessionSourceAsync GetUserSessionSourceAsync()
Returns​

ServiceStack.Auth.IUserSessionSourceAsync

GetAuthProvider(String)​

Get specific AuthProvider

View Source​
Declaration
public static IAuthProvider GetAuthProvider(string provider)
Returns​

ServiceStack.Auth.IAuthProvider

Parameters​
TypeName
System.Stringprovider

GetJwtAuthProvider()​

View Source​
Declaration
public static JwtAuthProviderReader GetJwtAuthProvider()
Returns​

ServiceStack.Auth.JwtAuthProviderReader

GetRequiredJwtAuthProvider()​

View Source​
Declaration
public static JwtAuthProviderReader GetRequiredJwtAuthProvider()
Returns​

ServiceStack.Auth.JwtAuthProviderReader

Init(Func<IAuthSession>, IAuthProvider[])​

View Source​
Declaration
public static void Init(Func<IAuthSession> sessionFactory, params IAuthProvider[] authProviders)
Parameters​
TypeName
System.Func<ServiceStack.Auth.IAuthSession>sessionFactory
ServiceStack.Auth.IAuthProvider[]authProviders

Options(Authenticate)​

View Source​
Declaration
public void Options(Authenticate request)
Parameters​
TypeName
ServiceStack.Authenticaterequest

GetAsync(Authenticate)​

View Source​
Declaration
public Task<object> GetAsync(Authenticate request)
Returns​

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

Parameters​
TypeName
ServiceStack.Authenticaterequest

Post(Authenticate)​

View Source​
Declaration
[Obsolete("Use PostAsync")]
public object Post(Authenticate request)
Returns​

System.Object

Parameters​
TypeName
ServiceStack.Authenticaterequest

PostAsync(Authenticate)​

View Source​
Declaration
public async Task<object> PostAsync(Authenticate request)
Returns​

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

Parameters​
TypeName
ServiceStack.Authenticaterequest

Authenticate(Authenticate)​

View Source​
Declaration
[Obsolete("Use AuthenticateAsync")]
public AuthenticateResponse Authenticate(Authenticate request)
Returns​

ServiceStack.AuthenticateResponse

Parameters​
TypeName
ServiceStack.Authenticaterequest

AuthenticateAsync(Authenticate, CancellationToken)​

Public API entry point to authenticate via code

View Source​
Declaration
public async Task<AuthenticateResponse> AuthenticateAsync(Authenticate request, CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task<ServiceStack.AuthenticateResponse>: null; if already authenticated otherwise a populated instance of AuthResponse

Parameters​
TypeName
ServiceStack.Authenticaterequest
System.Threading.CancellationTokentoken

DeleteAsync(Authenticate)​

View Source​
Declaration
public async Task<object> DeleteAsync(Authenticate request)
Returns​

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

Parameters​
TypeName
ServiceStack.Authenticaterequest

Inherited Methods​

AssertPlugin<T>()​

View Source​
Declaration
public T AssertPlugin<T>()
    where T : class, IPlugin
Returns​

<T>

Type Parameters​
  • T

Dispose()​

Disposes all created disposable properties of this service and executes disposing of all request System.IDisposables (warning, manually triggering this might lead to unwanted disposing of all request related objects and services.)

View Source​
Declaration
public virtual void Dispose()

DisposeAsync()​

View Source​
Declaration
public async ValueTask DisposeAsync()
Returns​

ValueTask

GetPlugin<T>()​

View Source​
Declaration
public T GetPlugin<T>()
    where T : class, IPlugin
Returns​

<T>

Type Parameters​
  • T

GetRedisAsync()​

View Source​
Declaration
public virtual ValueTask<IRedisClientAsync> GetRedisAsync()
Returns​

ValueTask<ServiceStack.Redis.IRedisClientAsync>

GetResolver()​

View Source​
Declaration
public virtual IResolver GetResolver()
Returns​

ServiceStack.Configuration.IResolver

GetSession(Boolean)​

View Source​
Declaration
public virtual IAuthSession GetSession(bool reload = false)
Returns​

ServiceStack.Auth.IAuthSession

Parameters​
TypeName
System.Booleanreload

GetSessionAsync(Boolean, CancellationToken)​

View Source​
Declaration
public virtual Task<IAuthSession> GetSessionAsync(bool reload = false, CancellationToken token = default(CancellationToken))
Returns​

System.Threading.Tasks.Task<ServiceStack.Auth.IAuthSession>

Parameters​
TypeName
System.Booleanreload
System.Threading.CancellationTokentoken

OnAfterExecute(Object)​

View Source​
Declaration
public virtual object OnAfterExecute(object response)
Returns​

System.Object

Parameters​
TypeName
System.Objectresponse

OnBeforeExecute(Object)​

View Source​
Declaration
public virtual void OnBeforeExecute(object requestDto)
Parameters​
TypeName
System.ObjectrequestDto

OnExceptionAsync(Object, Exception)​

View Source​
Declaration
public virtual Task<object> OnExceptionAsync(object requestDto, Exception ex)
Returns​

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

Parameters​
TypeName
System.ObjectrequestDto
System.Exceptionex

OpenDbConnection(String)​

View Source​
Declaration
public virtual IDbConnection OpenDbConnection(string namedConnection)
Returns​

System.Data.IDbConnection

Parameters​
TypeName
System.StringnamedConnection

PublishMessage<T>(T)​

Publish a MQ message over the ServiceStack.Messaging.IMessageProducer implementation.

View Source​
Declaration
public virtual void PublishMessage<T>(T message)
Parameters​
TypeName
<T>message
Type Parameters​
  • T

ResolveService<T>()​

View Source​
Declaration
public virtual T ResolveService<T>()
Returns​

<T>

Type Parameters​
  • T

SessionAs<TUserSession>()​

Typed UserSession

View Source​
Declaration
protected virtual TUserSession SessionAs<TUserSession>()
Returns​

<TUserSession>

Type Parameters​
  • TUserSession

SessionAsAsync<TUserSession>()​

Typed UserSession

View Source​
Declaration
protected virtual async Task<TUserSession> SessionAsAsync<TUserSession>()
Returns​

System.Threading.Tasks.Task<<TUserSession>>

Type Parameters​
  • TUserSession

SetResolver(IResolver)​

View Source​
Declaration
public virtual Service SetResolver(IResolver resolver)
Returns​

ServiceStack.Service

Parameters​
TypeName
ServiceStack.Configuration.IResolverresolver

TryResolve<T>()​

View Source​
Declaration
public virtual T TryResolve<T>()
Returns​

<T>

Type Parameters​
  • T

Implements​