Interface ILoginProperties

'Properties' object passed into the WL.login method.

Index

Properties

Properties

optional public redirect_uri?: string

This parameter only applies to web apps. Contains the redirect URI to be used for OAuth authentication. This value overrides the default redirect URI that is provided in the call to WL.init.

public scope: any

Specifies the scopes to which the user who is signing in consents.

For a single scope, use this format: scope: "wl.signin". For multiple scopes, use this format: scope: ["wl.signin", "wl.basic"].

If no scope is provided, the scope value of WL.init is used. If no scope is provided in WL.init or WL.login, WL.login returns an error.

Note WL.login can request the "wl.offline_access" scope, but it requires a server-side implementation, and the WL.init function must set its response_type property to "code". For more info, see Server-side scenarios. http://msdn.microsoft.com/en-us/library/live/hh243649.aspx

optional public state?: string

Windows Store apps using JavaScript: not applicable. Web apps: Optional. If the WL.init function's response_type object is set to "code" and the app uses server-flow authentication, the state object here can be used to track the web app's calling state on the web app server side. For more info, see the description of the state query parameter in the Server-side scenarios topic's "Getting an authorization code" section. http://msdn.microsoft.com/en-us/library/live/hh243649.aspx