WebTokenRequest WebTokenRequest WebTokenRequest WebTokenRequest Class

Definition

Represents a request to an online identity provider for an authentication token.

public : sealed class WebTokenRequest : IWebTokenRequest, IWebTokenRequest2, IWebTokenRequest3public sealed class WebTokenRequest : IWebTokenRequest, IWebTokenRequest2, IWebTokenRequest3Public NotInheritable Class WebTokenRequest Implements IWebTokenRequest, IWebTokenRequest2, IWebTokenRequest3// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Constructors

WebTokenRequest(WebAccountProvider) WebTokenRequest(WebAccountProvider) WebTokenRequest(WebAccountProvider) WebTokenRequest(WebAccountProvider)

WebTokenRequest(WebAccountProvider, String) WebTokenRequest(WebAccountProvider, String) WebTokenRequest(WebAccountProvider, String) WebTokenRequest(WebAccountProvider, String)

WebTokenRequest(WebAccountProvider, String, String) WebTokenRequest(WebAccountProvider, String, String) WebTokenRequest(WebAccountProvider, String, String) WebTokenRequest(WebAccountProvider, String, String)

Initializes a new instance of the WebTokenRequest class with three inputs.

public : WebTokenRequest(WebAccountProvider provider, PlatForm::String scope, PlatForm::String clientId)public WebTokenRequest(WebAccountProvider provider, String scope, String clientId)Public Sub New(provider As WebAccountProvider, scope As String, clientId As String)// You can use this method in JavaScript.
Parameters
provider
WebAccountProvider WebAccountProvider WebAccountProvider WebAccountProvider

The web account provider the request is for.

scope
PlatForm::String String String String

The scope of the request.

clientId
PlatForm::String String String String

The client Id.

See Also

WebTokenRequest(WebAccountProvider, String, String, WebTokenRequestPromptType) WebTokenRequest(WebAccountProvider, String, String, WebTokenRequestPromptType) WebTokenRequest(WebAccountProvider, String, String, WebTokenRequestPromptType) WebTokenRequest(WebAccountProvider, String, String, WebTokenRequestPromptType)

Initializes a new instance of the WebTokenRequest class with four inputs.

public : WebTokenRequest(WebAccountProvider provider, PlatForm::String scope, PlatForm::String clientId, WebTokenRequestPromptType promptType)public WebTokenRequest(WebAccountProvider provider, String scope, String clientId, WebTokenRequestPromptType promptType)Public Sub New(provider As WebAccountProvider, scope As String, clientId As String, promptType As WebTokenRequestPromptType)// You can use this method in JavaScript.
Parameters
provider
WebAccountProvider WebAccountProvider WebAccountProvider WebAccountProvider

The web account provider the request is for.

scope
PlatForm::String String String String

The scope of the request.

clientId
PlatForm::String String String String

The client Id.

See Also

Properties

AppProperties AppProperties AppProperties AppProperties

Gets the app properties of the request.

public : IMap<string, string> AppProperties { get; }public IDictionary<string, string> AppProperties { get; }Public ReadOnly Property AppProperties As IDictionary<string, string>// You can use this property in JavaScript.
Value
IMap<PlatForm::String, PlatForm::String> IDictionary<string, string> IDictionary<string, string> IDictionary<string, string>

The app properties of the request.

Additional features and requirements
Device family
Windows 10 (introduced v10.0.10586.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v2)

ClientId ClientId ClientId ClientId

Gets the Id of the client making the request.

public : PlatForm::String ClientId { get; }public string ClientId { get; }Public ReadOnly Property ClientId As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The Id of the client making the request.

See Also

CorrelationId CorrelationId CorrelationId CorrelationId

Gets and sets a correlation Id, a unique identifier used for tracking authentication-related requests.

public : PlatForm::String CorrelationId { get; set; }public string CorrelationId { get; set; }Public ReadWrite Property CorrelationId As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The correlation Id for this request.

Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

PromptType PromptType PromptType PromptType

Gets the prompt type of the request.

public : WebTokenRequestPromptType PromptType { get; }public WebTokenRequestPromptType PromptType { get; }Public ReadOnly Property PromptType As WebTokenRequestPromptType// You can use this property in JavaScript.
See Also

Properties Properties Properties Properties

Gets the properties of the request.

public : IMap<string, string> Properties { get; }public IDictionary<string, string> Properties { get; }Public ReadOnly Property Properties As IDictionary<string, string>// You can use this property in JavaScript.
Value
IMap<PlatForm::String, PlatForm::String> IDictionary<string, string> IDictionary<string, string> IDictionary<string, string>

The properties of the request.

See Also

Scope Scope Scope Scope

Gets the scope of the request.

public : PlatForm::String Scope { get; }public string Scope { get; }Public ReadOnly Property Scope As string// You can use this property in JavaScript.
Value
PlatForm::String string string string

The scope of the request.

See Also

WebAccountProvider WebAccountProvider WebAccountProvider WebAccountProvider

Gets the web account provider for the request.

public : WebAccountProvider WebAccountProvider { get; }public WebAccountProvider WebAccountProvider { get; }Public ReadOnly Property WebAccountProvider As WebAccountProvider// You can use this property in JavaScript.
Value
WebAccountProvider WebAccountProvider WebAccountProvider WebAccountProvider

The web account provider for the request.

See Also

See Also