GatewayConfiguration

Remote Desktop Gateway configuration and settings.

Type

RoyalApps.Community.Rdp.WinForms.Configuration.Connection.GatewayConfiguration

Properties

GatewayAccessToken (SensitiveString?)

Specifies the access token supplied to Remote Desktop Gateway Pluggable Authentication and Authorization (PAA). A non-empty token uses cookie-based gateway authentication with explicit gateway settings. Support: embedded and external sessions. Embedded mode protects the token with Windows DPAPI before assigning it to the ActiveX control. External mode writes gatewayaccesstoken into the temporary .rdp file.

GatewayCredSharing (bool) ↗

Specifies or retrieves the setting for whether the Remote Desktop Gateway (RD Gateway) credential sharing feature is enabled. When the feature is enabled, the Remote Desktop ActiveX control tries to use the same credentials to authenticate to the Remote Desktop Session Host (RD Session Host) server and to the RD Gateway server. Support: embedded and external sessions. External mode writes promptcredentialonce.

GatewayCredsSource (GatewayCredentialSource) ↗

Specifies or retrieves the Remote Desktop Gateway (RD Gateway) authentication method. Support: embedded and external sessions. External mode writes gatewaycredentialssource.

GatewayDomain (string?) ↗

Specifies or retrieves the domain name of a user that is provided to the Remote Desktop Gateway (RD Gateway) server. Support: embedded and external sessions. External mode writes gatewaydomain.

GatewayHostname (string?) ↗

Specifies the host name of the Remote Desktop Gateway (RD Gateway) server. Support: embedded and external sessions. External mode writes gatewayhostname.

GatewayPassword (SensitiveString?) ↗

Specifies the password that is used to authenticate to the Remote Desktop Gateway (RD Gateway) server. Support: embedded sessions directly. External mode does not serialize the password into the generated .rdp file, but can stage it in Windows Credential Manager when credential manager integration is enabled.

GatewayProfileUsageMethod (GatewayProfileUsageMethod) ↗

Specifies whether to use default Remote Desktop Gateway (RD Gateway) settings. Support: embedded and external sessions. External mode writes gatewayprofileusagemethod.

GatewayUsageMethod (GatewayUsageMethod) ↗

Specifies when to use a Remote Desktop Gateway (RD Gateway) server. Support: embedded and external sessions. External mode writes gatewayusagemethod.

GatewayUsername (string?) ↗

Specifies or retrieves the user name that is provided to the Remote Desktop Gateway (RD Gateway) server. Support: embedded and external sessions. External mode writes gatewayusername.

GatewayUserSelectedCredsSource (GatewayCredentialSource) ↗

Sets or retrieves the user-specified Remote Desktop Gateway (RD Gateway) credential source. Support: embedded and external sessions. External mode writes gatewayuserselectedcredentialssource.

Back to API index