Skip to main content
HotspotAuthenticationContext.IssueCredentials | issueCredentials method

Provides credentials to Windows for hotspot authentication

Note  

This functionality is only available to mobile operator apps and Windows Store apps given privileged access by mobile network operators.

For permission to use this API, please reach out to Network Operators API Permissions.

For technical help with this API, please reach out to Network Operators API Help

 
Windows does not cache these credentials and another authentication event will be raised when the system connects to the same hotspot again.

Syntax


hotspotAuthenticationContext.issueCredentials(userName, password, extraParameters, markAsManualConnectOnFailure);

public void IssueCredentials(
  string userName, 
  string password, 
  string extraParameters, 
  bool markAsManualConnectOnFailure
)

Public Sub IssueCredentials(
  userName As String,  
  password As String,  
  extraParameters As String,  
  markAsManualConnectOnFailure As Boolean 
)

public:
void IssueCredentials(
  String^ userName, 
  String^ password, 
  String^ extraParameters, 
  bool markAsManualConnectOnFailure
)

Parameters

userName

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

The UserName parameter of the Wireless Internet Service Provider roaming (WISPr) authentication protocol. IssueCredentials performs URL encoding before submitting the value to the server. If this string is empty, the corresponding authentication parameter is skipped.

password

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

The Password parameter of the WISPr authentication protocol. IssueCredentials performs URL encoding before submitting the value to the server. If this string is empty, the corresponding authentication parameter is skipped.

extraParameters

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

Additional parameters to be appended to the authentication string. IssueCredentials appends this parameter after an "&" character to the HTTP POST string as is without any encoding. This can be used to add multiple parameters. The default for this parameter is an empty string.

markAsManualConnectOnFailure

Type: Boolean [JavaScript] | System.Boolean [.NET] | Platform::Boolean [C++]

If true, an application permanently disables the auto-connect property on a connection. If authentication fails, the connection will be disconnected and not retried in the current user session. Otherwise, false.

Remarks

Once IssueCredentials is called, the authentication context is finalized and IssueCredentials, AbortAuthentication, or SkipAuthentication should not be called again.

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0 [for Xbox, see UWP features that aren't yet supported on Xbox]

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.Networking.NetworkOperators
Windows::Networking::NetworkOperators [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.Networking.NetworkOperators
Windows::Networking::NetworkOperators [C++]

Metadata

Windows.winmd

See also

HotspotAuthenticationContext