OAuthOptions Class

Configuration options for Microsoft.AspNetCore.Authentication.OAuth.OAuthMiddleware`1.

Namespace
Microsoft.AspNetCore.Builder
Assemblies
  • Microsoft.AspNetCore.Authentication.OAuth

Syntax

public class OAuthOptions : RemoteAuthenticationOptions
class Microsoft.AspNetCore.Builder.OAuthOptions

Constructors

OAuthOptions()
public OAuthOptions()

Properties

Microsoft.AspNetCore.Builder.OAuthOptions.AuthorizationEndpoint

Gets or sets the URI where the client will be redirected to authenticate.

Return type:System.String 
public string AuthorizationEndpoint { get; set; }
Microsoft.AspNetCore.Builder.OAuthOptions.ClientId

Gets or sets the provider-assigned client id.

Return type:System.String 
public string ClientId { get; set; }
Microsoft.AspNetCore.Builder.OAuthOptions.ClientSecret

Gets or sets the provider-assigned client secret.

Return type:System.String 
public string ClientSecret { get; set; }
Microsoft.AspNetCore.Builder.OAuthOptions.Events

Gets or sets the Microsoft.AspNetCore.Authentication.OAuth.IOAuthEvents used to handle authentication events.

Return type:Microsoft.AspNetCore.Authentication.OAuth.IOAuthEvents 
public IOAuthEvents Events { get; set; }
Microsoft.AspNetCore.Builder.OAuthOptions.Scope

Gets the list of permissions to request.

Return type:System.Collections.Generic.ICollection<System.String> 
public ICollection<string> Scope { get; }
Microsoft.AspNetCore.Builder.OAuthOptions.StateDataFormat

Gets or sets the type used to secure data handled by the middleware.

Return type:Microsoft.AspNetCore.Authentication.ISecureDataFormat<Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties> 
public ISecureDataFormat<AuthenticationProperties> StateDataFormat { get; set; }
Microsoft.AspNetCore.Builder.OAuthOptions.SystemClock

For testing purposes only.

Return type:Microsoft.AspNetCore.Authentication.ISystemClock 
[EditorBrowsable(EditorBrowsableState.Never)]
public ISystemClock SystemClock { get; set; }
Microsoft.AspNetCore.Builder.OAuthOptions.TokenEndpoint

Gets or sets the URI the middleware will access to exchange the OAuth token.

Return type:System.String 
public string TokenEndpoint { get; set; }
Microsoft.AspNetCore.Builder.OAuthOptions.UserInformationEndpoint

Gets or sets the URI the middleware will access to obtain the user information. This value is not used in the default implementation, it is for use in custom implementations of IOAuthAuthenticationEvents.Authenticated or OAuthAuthenticationHandler.CreateTicketAsync.

Return type:System.String 
public string UserInformationEndpoint { get; set; }