OAuthAuthorizationServerProvider.GrantRefreshToken Method (OAuthGrantRefreshTokenContext)

  • Article

 

Called when a request to the Token endpoint arrives with a "grant_type" of "refresh_token". This occurs if your application has issued a "refresh_token" along with the "access_token", and the client is attempting to use the "refresh_token" to acquire a new "access_token", and possibly a new "refresh_token". To issue a refresh token the an Options.RefreshTokenProvider must be assigned to create the value which is returned. The claims and properties associated with the refresh token are present in the context.Ticket. The application must call context.Validated to instruct the Authorization Server middleware to issue an access token based on those claims and properties. The call to context.Validated may be given a different AuthenticationTicket or ClaimsIdentity in order to control which information flows from the refresh token to the access token. The default behavior when using the OAuthAuthorizationServerProvider is to flow information from the refresh token to the access token unmodified. See also http://tools.ietf.org/html/rfc6749\#section-6

Namespace:   Microsoft.Owin.Security.OAuth
Assembly:  Microsoft.Owin.Security.OAuth (in Microsoft.Owin.Security.OAuth.dll)

Syntax

public virtual Task GrantRefreshToken(
    OAuthGrantRefreshTokenContext context
)

public:
virtual Task^ GrantRefreshToken(
    OAuthGrantRefreshTokenContext^ context
)

abstract GrantRefreshToken : 
        context:OAuthGrantRefreshTokenContext -> Task
override GrantRefreshToken : 
        context:OAuthGrantRefreshTokenContext -> Task

Public Overridable Function GrantRefreshToken (
    context As OAuthGrantRefreshTokenContext
) As Task

Parameters

Return Value

Type: System.Threading.Tasks.Task

Task to enable asynchronous execution

Implements

IOAuthAuthorizationServerProvider.GrantRefreshToken(OAuthGrantRefreshTokenContext)

See Also

OAuthAuthorizationServerProvider Class
Microsoft.Owin.Security.OAuth Namespace

Return to top