LiveClient Class

Nemiro.OAuth

OAuth client for Microsoft Live.

Inheritance Hierarchy

System Object
  Nemiro.OAuth OAuthBase
    Nemiro.OAuth OAuth2Client
      Nemiro.OAuth.Clients LiveClient

Namespace: Nemiro.OAuth.Clients
Assembly: Nemiro.OAuth (in Nemiro.OAuth.dll) Version: 1.9.4.725 (1.9.4.725)

Syntax

public class LiveClient : OAuth2Client

public class LiveClient : OAuth2Client

Public Class LiveClient 
	Inherits OAuth2Client

Public Class LiveClient 
	Inherits OAuth2Client

The LiveClient type exposes the following members.

Constructors

	Name	Description
	LiveClient	Initializes a new instance of the LiveClient.

Top

Methods

	Name	Description
	Clone	Creates a shallow copy of the current object. (Inherited from OAuthBase.)
	Clone(NameValueCollection, String)	Creates a shallow copy of the current object. (Inherited from OAuthBase.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetAccessToken	Gets the access token from the remote server. (Inherited from OAuth2Client.)
	GetHashCode	(Inherited from Object.)
	GetSpecifiedTokenOrCurrent	Returns the specified access token or the current access token. (Inherited from OAuthBase.)
	GetType	(Inherited from Object.)
	GetUserInfo	Obsolete. Gets the user details via API of the provider. (Inherited from OAuthBase.)
	GetUserInfo(AccessToken)	Gets the user details. (Overrides OAuthBase GetUserInfo(AccessToken).)
	MemberwiseClone	(Inherited from Object.)
	RedirectToAuthorization	Redirects a client to the Authorization URL. (Inherited from OAuthBase.)
	RefreshToken	Sends a request to refresh the access token. (Overrides OAuth2Client RefreshToken(AccessToken).)
	RevokeToken	Sends a request to revoke the access token. (Inherited from OAuthBase.)
	ToString	(Inherited from Object.)

Top

Properties

	Name	Description
	AccessToken	Gets or sets an access token. (Inherited from OAuthBase.)
	AccessTokenUrl	Gets or sets the address for the access token. (Inherited from OAuthBase.)
	AccessTokenValue	Gets an access token value. (Inherited from OAuthBase.)
	ApplicationId	Gets or sets the application identifier. (Inherited from OAuthBase.)
	ApplicationSecret	Gets or sets the application secret key. (Inherited from OAuthBase.)
	AuthorizationCode	Gets or sets access code for access token requests. (Inherited from OAuthBase.)
	AuthorizationUrl	Gets the endpoint of the authorization. (Inherited from OAuth2Client.)
	AuthorizeUrl	Gets or sets the base address for login. (Inherited from OAuthBase.)
	DefaultScope	The deault scope. (Inherited from OAuth2Client.)
	GrantType	Gets or sets grant type. (Inherited from OAuth2Client.)
	Parameters	Gets or sets additional query parameters. (Inherited from OAuthBase.)
	Password	Gets or sets password if GrantType is password or client_credentials. (Inherited from OAuth2Client.)
	ProviderName	Unique provider name: Live. (Overrides OAuthBase ProviderName.)
	ReturnUrl	Gets or sets return URL. (Inherited from OAuthBase.)
	Scope	The scope of the access request. (Inherited from OAuth2Client.)
	ScopeSeparator	The separator in the scope list. (Inherited from OAuth2Client.)
	State	Gets or sets unique request identifier. For clients the value sets is automatically. (Inherited from OAuthBase.)
	SupportRefreshToken	Gets or sets a value indicating whether the current client supports refreshing access token. (Inherited from OAuthBase.)
	SupportRevokeToken	Gets or sets a value indicating whether the current client supports revoking access token. (Inherited from OAuthBase.)
	Username	Gets or sets username if GrantType is password or client_credentials. (Inherited from OAuth2Client.)
	Version	Gets the version of the OAuth protocol. (Inherited from OAuthBase.)

Top

Remarks

Register and Configure a Live Application

Web Management Interface may change over time. Applications registration shown below may differ.
If the interface is changed, you need to register the application and get Client ID and Client Secret. For web projects, configure return URLs.
If you have any problems with this, please visit issues. If you do not find a solution to your problem, you can create a new question.

Open the Live Connect App Management and Create a New Application.

Create a New Application

Specify the application name, read terms of use and click the I accept.

Create a New Application form

Open the App Settings and add return URLs. You can't use localhost.

Redirect URLs

On the App Settings page, you can found Client ID and Client Secret.

Use this for creating an instance of the LiveClient.

Cleint ID and Client Secret

C++

Copy to Clipboard Print

OAuthManager.RegisterClient
(
  new LiveClient
  (
    "0000000040124265", 
    "6ViSGIbw9N59s5Ndsfz-zaeezlBt62Ep"
  )
);

OAuthManager.RegisterClient
(
  new LiveClient
  (
    "0000000040124265", 
    "6ViSGIbw9N59s5Ndsfz-zaeezlBt62Ep"
  )
);

OAuthManager.RegisterClient _
(
  New LiveClient _
  (
    "0000000040124265", 
    "6ViSGIbw9N59s5Ndsfz-zaeezlBt62Ep"
  )
)

OAuthManager.RegisterClient _
(
  New LiveClient _
  (
    "0000000040124265", 
    "6ViSGIbw9N59s5Ndsfz-zaeezlBt62Ep"
  )
)

For more details, please visit to the MSDN.

Examples

The following example shows how to add the Microsoft Live OAuth Client to ASP .NET MVC Application.

In the Application_Start event handler (Global.asax file) is registered the LiveClient.

C++

Copy to Clipboard Print

protected void Application_Start()
{
  OAuthManager.RegisterClient
  (
    new LiveClient
    (
      "0000000040124265", 
      "6ViSGIbw9N59s5Ndsfz-zaeezlBt62Ep"
    )
  );
}

protected void Application_Start()
{
  OAuthManager.RegisterClient
  (
    new LiveClient
    (
      "0000000040124265", 
      "6ViSGIbw9N59s5Ndsfz-zaeezlBt62Ep"
    )
  );
}

Sub Application_Start()
  OAuthManager.RegisterClient _
  (
    New LiveClient _
    (
      "0000000040124265", 
      "6ViSGIbw9N59s5Ndsfz-zaeezlBt62Ep"
    )
  )
End Sub

Sub Application_Start()
  OAuthManager.RegisterClient _
  (
    New LiveClient _
    (
      "0000000040124265", 
      "6ViSGIbw9N59s5Ndsfz-zaeezlBt62Ep"
    )
  )
End Sub

The LiveLoginResult method will handle authorization result.

C++

Copy to Clipboard Print

public ActionResult LiveLoginResult()
{
  var result = OAuthWeb.VerifyAuthorization();
  if (result.IsSuccessfully)
  {
    var user = result.UserInfo;    
    // NOTE: For StringBuilder import the System.Text
    StringBuilder r = new StringBuilder();
    r.AppendFormat("User ID: {0}\r\n", user.UserId);
    r.AppendFormat("Name:    {0}\r\n", user.DisplayName);
    r.AppendFormat("Email:   {0}", user.Email);
    return new ContentResult { Content = r.ToString(), ContentType = "text/plain" }; 
  }

  return new ContentResult 
  { 
    Content = "Error: " + result.ErrorInfo.Message, 
    ContentType = "text/plain" 
  };
}

public ActionResult LiveLoginResult()
{
  var result = OAuthWeb.VerifyAuthorization();
  if (result.IsSuccessfully)
  {
    var user = result.UserInfo;    
    // NOTE: For StringBuilder import the System.Text
    StringBuilder r = new StringBuilder();
    r.AppendFormat("User ID: {0}\r\n", user.UserId);
    r.AppendFormat("Name:    {0}\r\n", user.DisplayName);
    r.AppendFormat("Email:   {0}", user.Email);
    return new ContentResult { Content = r.ToString(), ContentType = "text/plain" }; 
  }

  return new ContentResult 
  { 
    Content = "Error: " + result.ErrorInfo.Message, 
    ContentType = "text/plain" 
  };
}

Public Function LiveLoginResult() As ActionResult
  Dim result As AuthorizationResult = OAuthWeb.VerifyAuthorization()
  If result.IsSuccessfully Then 
    Dim user As UserInfo = result.UserInfo   
    ' NOTE: For StringBuilder import the System.Text 
    Dim r As New StringBuilder()
    r.AppendFormat("User ID: {0}", user.UserId)
    r.AppendLine()
    r.AppendFormat("Name:    {0}", user.DisplayName)
    r.AppendLine()
    r.AppendFormat("Email:   {0}", user.Email)
    Return New ContentResult With { .Content = r.ToString(), .ContentType = "text/plain" } 
  End If 

  Return New ContentResult With _
  { 
    .Content = "Error: " + result.ErrorInfo.Message, 
    .ContentType = "text/plain" 
  }
End Function

Public Function LiveLoginResult() As ActionResult
  Dim result As AuthorizationResult = OAuthWeb.VerifyAuthorization()
  If result.IsSuccessfully Then 
    Dim user As UserInfo = result.UserInfo   
    ' NOTE: For StringBuilder import the System.Text 
    Dim r As New StringBuilder()
    r.AppendFormat("User ID: {0}", user.UserId)
    r.AppendLine()
    r.AppendFormat("Name:    {0}", user.DisplayName)
    r.AppendLine()
    r.AppendFormat("Email:   {0}", user.Email)
    Return New ContentResult With { .Content = r.ToString(), .ContentType = "text/plain" } 
  End If 

  Return New ContentResult With _
  { 
    .Content = "Error: " + result.ErrorInfo.Message, 
    .ContentType = "text/plain" 
  }
End Function

Add action method for redirection to the Microsoft Live.

C++

Copy to Clipboard Print

public ActionResult LiveLogin()
{
  string authUrl = OAuthWeb.GetAuthorizationUrl("Live", Url.Action("LiveLoginResult", "Home", null, null, Request.Url.Host));
  return Redirect(authUrl);
}

public ActionResult LiveLogin()
{
  string authUrl = OAuthWeb.GetAuthorizationUrl("Live", Url.Action("LiveLoginResult", "Home", null, null, Request.Url.Host));
  return Redirect(authUrl);
}

Public Function LiveLogin() As ActionResult
  Dim authUrl As String = OAuthWeb.GetAuthorizationUrl("Live", Url.Action("LiveLoginResult", "Home", Nothing, Nothing, Request.Url.Host))
  Return Redirect(authUrl)
End Function

Public Function LiveLogin() As ActionResult
  Dim authUrl As String = OAuthWeb.GetAuthorizationUrl("Live", Url.Action("LiveLoginResult", "Home", Nothing, Nothing, Request.Url.Host))
  Return Redirect(authUrl)
End Function

On a page add link to the LiveLogin method.

HTML

Copy to Clipboard Print

@Html.ActionLink("Log in with Microsoft Live", "LiveLogin")

@Html.ActionLink("Log in with Microsoft Live", "LiveLogin")

Result shown in the images below.

Microsoft Live Sign in

User Info