The description of the client applications More...
Public Member Functions | |
| Task< AuthenticationResult > | AuthenticateUserAsync (string userName, string password) |
| Authenticate user using its login and password More... | |
| Task< AuthenticationResult > | AuthenticateSelf () |
| The application authenticates itself and will make operations on it's own behalf. More... | |
| Task< AuthenticationResult > | AuthenticateWithRefreshTicket (RefreshTicket refreshTicket) |
| Renews authentication session More... | |
Properties | |
| string | ClientId [get] |
| Gets the client application id More... | |
| string | Name [get] |
| Gets the client application name More... | |
| string | Type [get] |
| Gets the client type name More... | |
| IEnumerable< string > | OwnScope [get] |
| Gets the authorization scope for application More... | |
Detailed Description
The description of the client applications
Definition at line 18 of file IClient.cs.
Member Function Documentation
◆ AuthenticateSelf()
| Task<AuthenticationResult> KlusterKite.Security.Attributes.IClient.AuthenticateSelf | ( | ) |
The application authenticates itself and will make operations on it's own behalf.
- Returns
- The generated user session or null, in case self authentication is denied
Implemented in KlusterKite.NodeManager.Authentication.Clients.WebApplication, and KlusterKite.NodeManager.Authentication.Clients.Launcher.
◆ AuthenticateUserAsync()
| Task<AuthenticationResult> KlusterKite.Security.Attributes.IClient.AuthenticateUserAsync | ( | string | userName, |
| string | password | ||
| ) |
Authenticate user using its login and password
- Parameters
-
userName The user name (login) password The user password
- Returns
- The authenticated user or null
Implemented in KlusterKite.NodeManager.Authentication.Clients.WebApplication, and KlusterKite.NodeManager.Authentication.Clients.Launcher.
◆ AuthenticateWithRefreshTicket()
| Task<AuthenticationResult> KlusterKite.Security.Attributes.IClient.AuthenticateWithRefreshTicket | ( | RefreshTicket | refreshTicket | ) |
Renews authentication session
- Parameters
-
refreshTicket The refresh ticket data
- Returns
- The subsequent authentication result
Implemented in KlusterKite.NodeManager.Authentication.Clients.WebApplication, and KlusterKite.NodeManager.Authentication.Clients.Launcher.
Property Documentation
◆ ClientId
|
get |
Gets the client application id
Definition at line 23 of file IClient.cs.
◆ Name
|
get |
Gets the client application name
Definition at line 28 of file IClient.cs.
◆ OwnScope
|
get |
Gets the authorization scope for application
Definition at line 38 of file IClient.cs.
◆ Type
|
get |
Gets the client type name
Definition at line 33 of file IClient.cs.
The documentation for this interface was generated from the following file:
- KlusterKite.Security/KlusterKite.Security.Attributes/IClient.cs
