Early Preview
This is currently very much a preview. Please feel free to try things out,
but don't be upset if anything is not yet working. Feedback is welcome over on our
GitHub Dicussions page.
class Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions
Assembly: Microsoft.AspNetCore.Authentication
Inheritance: object → AuthenticationSchemeOptions → RemoteAuthenticationOptions
Contains the options used by the <see cref="T:Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler`1" /> .
Properties
public
System.TimeSpan
BackchannelTimeout
Gets or sets timeout value in milliseconds for back channel communications with the remote identity provider.
BackchannelHttpHandler
The HttpMessageHandler used to communicate with remote identity provider.
This cannot be set at the same time as BackchannelCertificateValidator unless the value
can be downcast to a WebRequestHandler.
Backchannel
Used to communicate with the remote identity provider.
DataProtectionProvider
Gets or sets the type used to secure data.
public
Http.PathString
CallbackPath
The request path within the application's base path where the user-agent will be returned.
The middleware will process this request when it arrives.
public
Http.PathString
AccessDeniedPath
Gets or sets the optional path the user agent is redirected to if the user
doesn't approve the authorization demand requested by the remote server.
This property is not set by default. In this case, an exception is thrown
if an access_denied response is returned by the remote authorization server.
public
string
ReturnUrlParameter
Gets or sets the name of the parameter used to convey the original location
of the user before the remote challenge was triggered up to the access denied page.
This property is only used when the <see cref="P:Microsoft.AspNetCore.Authentication.RemoteAuthenticationOptions.AccessDeniedPath" /> is explicitly specified.
public
string
SignInScheme
Gets or sets the authentication scheme corresponding to the middleware
responsible for persisting user's identity after a successful authentication.
This value typically corresponds to a cookie middleware registered in the Startup class.
When omitted, <see cref="P:Microsoft.AspNetCore.Authentication.AuthenticationOptions.DefaultSignInScheme" /> is used as a fallback value.
public
System.TimeSpan
RemoteAuthenticationTimeout
Gets or sets the time limit for completing the authentication flow (15 minutes by default).
public
RemoteAuthenticationEvents
Events
Gets or sets a value that allows subscribing to remote authentication events.
public
bool
SaveTokens
Defines whether access and refresh tokens should be stored in the
<see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationProperties" /> after a successful authorization.
This property is set to <c>false</c> by default to reduce
the size of the final authentication cookie.
public
Http.CookieBuilder
CorrelationCookie
Determines the settings used to create the correlation cookie before the
cookie gets added to the response.
Remarks <para>
If an explicit <see cref="P:Microsoft.AspNetCore.Http.CookieBuilder.Name" /> is not provided, the system will automatically generate a
unique name that begins with <c>.AspNetCore.Correlation.</c>.
</para> <list type="bullet">
<item>
<description>
<see cref="P:Microsoft.AspNetCore.Http.CookieBuilder.SameSite" /> defaults to <see cref="F:Microsoft.AspNetCore.Http.SameSiteMode.None" />.</description>
</item>
<item>
<description>
<see cref="P:Microsoft.AspNetCore.Http.CookieBuilder.HttpOnly" /> defaults to <c>true</c>.</description>
</item>
<item>
<description>
<see cref="P:Microsoft.AspNetCore.Http.CookieBuilder.IsEssential" /> defaults to <c>true</c>.</description>
</item>
<item>
<description>
<see cref="P:Microsoft.AspNetCore.Http.CookieBuilder.SecurePolicy" /> defaults to <see cref="F:Microsoft.AspNetCore.Http.CookieSecurePolicy.Always" />.</description>
</item>
</list>
public
string
ClaimsIssuer
Gets or sets the issuer that should be used for any claims that are created
public
object
Events
Instance used for events
public
System.Type
EventsType
If set, will be used as the service type to get the Events instance instead of the property.
public
string
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.
public
string
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.
public
string
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.
public
string
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.
public
string
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.
public
string
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.
public
System.Func<Http.HttpContext, string>
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.
public
System.TimeProvider
TimeProvider
Used for testing.
Methods
public
void
Validate(string scheme)
Checks that the options are valid for a specific scheme
scheme
The scheme being validated.
public
void
Validate()
Check that the options are valid. Should throw an exception if things are not ok.
public
bool
Equals(object obj)
Inherited from object
protected
void
Finalize()
Inherited from object
public
int
GetHashCode()
Inherited from object
protected
object
MemberwiseClone()
Inherited from object
public
string
ToString()
Inherited from object