ScreenSharingConnection
The declaration to configure a connection to a screen-sharing host.
Declaration
object ScreenSharingConnectionProperties
| Name | Type | Description |
|---|---|---|
AuthenticationCredentialsAssetReference | string | The identifier of an asset declaration that contains the required credentials for this connection to authenticate with the screen-sharing server. Set the corresponding asset type to |
ConnectionUUID Required | string | A unique identifier for this connection when it’s in a connection group. |
DisplayConfiguration Required | ScreenSharingConnectionDisplayConfigurationObject | The display configuration for this connection. |
DisplayName Required | string | The name of the connection. |
HostName Required | string | The host name or IP address of the Mac that hosts the screen-sharing connection. |
Port | integer | The TCP port number on the host to initiate the connection. |
Discussion
Specify com.apple.configuration.screensharing.connection as the declaration type.
Configuration availability
Allowed in supervised enrollment | macOS |
Allowed in device enrollment | NA |
Allowed in user enrollment | macOS |
Allowed in local enrollment | macOS |
Allowed in system scope | macOS |
Allowed in user scope | macOS |
Configuration example
{
"Type": "com.apple.configuration.screensharing.connection",
"Identifier": "EB13EE2B-5D63-4EBA-810F-5B81D07F5017",
"ServerToken": "E180CA9A-F089-4FA3-BBDF-94CC159C4AE8",
"Payload": {
"ConnectionUUID": "FA80E209-B31B-4862-B880-399F79E8FC35",
"HostName": "example.com",
"DisplayName": "Host1",
"DisplayConfiguration": {
"DisplayType": "Virtual1",
"UseHDR": true
}
}
}