Gemstone Security Library
APIAuthentication
Options for the APIAuthenticationHandler class.
Definition
Namespace: Gemstone.Security.AuthenticationProviders
Assembly: Gemstone.Security (in Gemstone.Security.dll) Version: 1.0.181 -- Release Build+ddfc5abcc226f4dec0986b2a0da5f8a889a81a36
Assembly: Gemstone.Security (in Gemstone.Security.dll) Version: 1.0.181 -- Release Build+ddfc5abcc226f4dec0986b2a0da5f8a889a81a36
C#
public class APIAuthenticationOptions : AuthenticationSchemeOptionsVB
Public Class APIAuthenticationOptions
Inherits AuthenticationSchemeOptionsC++
public ref class APIAuthenticationOptions : public AuthenticationSchemeOptionsJavaScript
Gemstone.Security.AuthenticationProviders.APIAuthenticationOptions = function();
Type.createClass(
'Gemstone.Security.AuthenticationProviders.APIAuthenticationOptions',
Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions);- Inheritance
- Object AuthenticationSchemeOptions APIAuthenticationOptions
Constructors
| APIAuthenticationOptions | Initializes a new instance of the APIAuthenticationOptions class |
Properties
| ClaimsIssuer |
Gets or sets the issuer that should be used for any claims that are created
(Inherited from AuthenticationSchemeOptions) |
| Events |
Instance used for events
(Inherited from AuthenticationSchemeOptions) |
| EventsType |
If set, will be used as the service type to get the Events instance instead of the property.
(Inherited from AuthenticationSchemeOptions) |
| ForwardAuthenticate |
If set, this specifies the target scheme that this scheme should forward AuthenticateAsync calls to.
For example Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue");
Set the target to the current scheme to disable forwarding and allow normal processing.
(Inherited from AuthenticationSchemeOptions) |
| ForwardChallenge |
If set, this specifies the target scheme that this scheme should forward ChallengeAsync calls to.
For example Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue");
Set the target to the current scheme to disable forwarding and allow normal processing.
(Inherited from AuthenticationSchemeOptions) |
| ForwardDefault |
If set, this specifies a default scheme that authentication handlers should forward all authentication operations to
by default. The default forwarding logic will check the most specific ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut
setting first, followed by checking the ForwardDefaultSelector, followed by ForwardDefault. The first non null result
will be used as the target scheme to forward to.
(Inherited from AuthenticationSchemeOptions) |
| ForwardDefaultSelector |
Used to select a default scheme for the current request that authentication handlers should forward all authentication operations to
by default. The default forwarding logic will check the most specific ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut
setting first, followed by checking the ForwardDefaultSelector, followed by ForwardDefault. The first non null result
will be used as the target scheme to forward to.
(Inherited from AuthenticationSchemeOptions) |
| ForwardForbid |
If set, this specifies the target scheme that this scheme should forward ForbidAsync calls to.
For example Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue");
Set the target to the current scheme to disable forwarding and allow normal processing.
(Inherited from AuthenticationSchemeOptions) |
| ForwardSignIn |
If set, this specifies the target scheme that this scheme should forward SignInAsync calls to.
For example Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue");
Set the target to the current scheme to disable forwarding and allow normal processing.
(Inherited from AuthenticationSchemeOptions) |
| ForwardSignOut |
If set, this specifies the target scheme that this scheme should forward SignOutAsync calls to.
For example Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue");
Set the target to the current scheme to disable forwarding and allow normal processing.
(Inherited from AuthenticationSchemeOptions) |
| TimeProvider |
Used for testing.
(Inherited from AuthenticationSchemeOptions) |
| ValidateToken | Function that parses and validates an API token. |
Methods
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Validate |
Check that the options are valid. Should throw an exception if things are not ok.
(Inherited from AuthenticationSchemeOptions) |
| Validate(String) |
Checks that the options are valid for a specific scheme
(Inherited from AuthenticationSchemeOptions) |