OAuthGrantClientCredentialsContext Class
Provides context information used in handling an OAuth client credentials grant.
Namespace: Microsoft.Owin.Security.OAuth
Assembly: Microsoft.Owin.Security.OAuth (in Microsoft.Owin.Security.OAuth.dll)
Inheritance Hierarchy
System.Object
Microsoft.Owin.Security.Provider.BaseContext<TOptions>
Microsoft.Owin.Security.OAuth.BaseValidatingContext<TOptions>
Microsoft.Owin.Security.OAuth.BaseValidatingTicketContext<TOptions>
Microsoft.Owin.Security.OAuth.OAuthGrantClientCredentialsContext
Syntax
public class OAuthGrantClientCredentialsContext : BaseValidatingTicketContext<OAuthAuthorizationServerOptions>
public ref class OAuthGrantClientCredentialsContext : BaseValidatingTicketContext<OAuthAuthorizationServerOptions^>
type OAuthGrantClientCredentialsContext =
class
inherit BaseValidatingTicketContext<OAuthAuthorizationServerOptions>
end
Public Class OAuthGrantClientCredentialsContext
Inherits BaseValidatingTicketContext(Of OAuthAuthorizationServerOptions)
Constructors
Name | Description | |
---|---|---|
OAuthGrantClientCredentialsContext(IOwinContext, OAuthAuthorizationServerOptions, String, IList<String>) | Initializes a new instance of the OAuthGrantClientCredentialsContext class |
Properties
Name | Description | |
---|---|---|
ClientId | OAuth client id. |
|
Error | The error argument provided when SetError was called on this context. This is eventually returned to the client app as the OAuth "error" parameter.(Inherited from BaseValidatingContext<TOptions>.) |
|
ErrorDescription | The optional errorDescription argument provided when SetError was called on this context. This is eventually returned to the client app as the OAuth "error_description" parameter.(Inherited from BaseValidatingContext<TOptions>.) |
|
ErrorUri | The optional errorUri argument provided when SetError was called on this context. This is eventually returned to the client app as the OAuth "error_uri" parameter.(Inherited from BaseValidatingContext<TOptions>.) |
|
HasError | True if application code has called any of the SetError methods on this context.(Inherited from BaseValidatingContext<TOptions>.) |
|
IsValidated | True if application code has called any of the Validate methods on this context.(Inherited from BaseValidatingContext<TOptions>.) |
|
Options | (Inherited from BaseContext<TOptions>.) |
|
OwinContext | (Inherited from BaseContext<TOptions>.) |
|
Request | (Inherited from BaseContext<TOptions>.) |
|
Response | (Inherited from BaseContext<TOptions>.) |
|
Scope | List of scopes allowed by the resource owner. |
|
Ticket | Contains the identity and properties for the application to authenticate. If the Validated method is invoked with an AuthenticationTicket or ClaimsIdentity argument, that new value is assigned to this property in addition to changing IsValidated to true.(Inherited from BaseValidatingTicketContext<TOptions>.) |
Methods
Name | Description | |
---|---|---|
Equals(Object) | (Inherited from Object.) |
|
Finalize() | (Inherited from Object.) |
|
GetHashCode() | (Inherited from Object.) |
|
GetType() | (Inherited from Object.) |
|
MemberwiseClone() | (Inherited from Object.) |
|
Rejected() | Marks this context as not validated by the application. IsValidated and HasError become false as a result of calling.(Inherited from BaseValidatingContext<TOptions>.) |
|
SetError(String) | Marks this context as not validated by the application and assigns various error information properties. HasError becomes true and IsValidated becomes false as a result of calling.(Inherited from BaseValidatingContext<TOptions>.) |
|
SetError(String, String) | Marks this context as not validated by the application and assigns various error information properties. HasError becomes true and IsValidated becomes false as a result of calling.(Inherited from BaseValidatingContext<TOptions>.) |
|
SetError(String, String, String) | Marks this context as not validated by the application and assigns various error information properties. HasError becomes true and IsValidated becomes false as a result of calling.(Inherited from BaseValidatingContext<TOptions>.) |
|
ToString() | (Inherited from Object.) |
|
Validated() | Marks this context as validated by the application. IsValidated becomes true and HasError becomes false as a result of calling.(Inherited from BaseValidatingContext<TOptions>.) |
|
Validated(AuthenticationTicket) | Replaces the ticket information on this context and marks it as as validated by the application. IsValidated becomes true and HasError becomes false as a result of calling.(Inherited from BaseValidatingTicketContext<TOptions>.) |
|
Validated(ClaimsIdentity) | Alters the ticket information on this context and marks it as as validated by the application. IsValidated becomes true and HasError becomes false as a result of calling.(Inherited from BaseValidatingTicketContext<TOptions>.) |
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
Microsoft.Owin.Security.OAuth Namespace
Return to top