Interface IClientAuthenticationManager
Manages authentication tokens, refresh tokens, and ILoggerProviders.
Namespace: LemonEdge.API.Authentication
Assembly: LemonEdge.API.dll
Syntax
public interface IClientAuthenticationManager
Properties
ActiveProvider
Gets the active / chosen ILoginProvider.
Declaration
ILoginProvider ActiveProvider { get; }
Property Value
Type | Description |
---|---|
ILoginProvider |
LoginProviders
Gets the list of available ILoginProviders.
Declaration
ILoginProvider[] LoginProviders { get; }
Property Value
Type | Description |
---|---|
ILoginProvider[] |
Methods
ApplyToken(HttpRequestMessage, IConnector)
Applies the current user's access token to the provided HttpRequestMessage.
Declaration
void ApplyToken(HttpRequestMessage requestMessage, IConnector connector)
Parameters
Type | Name | Description |
---|---|---|
HttpRequestMessage | requestMessage | |
IConnector | connector |
DetermineTokenState(IConnector)
Returns the state of the current user's access token. This can return an AccessTokenState or throw any of the exceptions below.
Declaration
AccessTokenState DetermineTokenState(IConnector connector)
Parameters
Type | Name | Description |
---|---|---|
IConnector | connector |
Returns
Type | Description |
---|---|
AccessTokenState |
Exceptions
Type | Condition |
---|---|
CustomMessageException | A CustomMessageException for the user to log out |
ArgumentException | A token parsing error |
SecurityTokenException | The token could not be refreshed |
RefreshToken(IConnector)
Attempts to refresh the current user's access token. HttpRequestMessage. If the token is about to expire, it silently refreshes the token.
Declaration
Task RefreshToken(IConnector connector)
Parameters
Type | Name | Description |
---|---|---|
IConnector | connector |
Returns
Type | Description |
---|---|
Task |
Exceptions
Type | Condition |
---|---|
CustomMessageException | A CustomMessageException for the user to log out |
ArgumentException | A token parsing error |
SecurityTokenException | The token could not be refreshed |
SetSelectedLoginProvider(ILoginProvider)
Sets / chooses the active ILoginProvider.
Declaration
void SetSelectedLoginProvider(ILoginProvider provider)
Parameters
Type | Name | Description |
---|---|---|
ILoginProvider | provider |