Skip to content

serviceprincipal-post-remotedesktopsecurityconfiguration.md

Latest commit

 

History

History
104 lines (79 loc) · 4.42 KB

serviceprincipal-post-remotedesktopsecurityconfiguration.md

File metadata and controls

104 lines (79 loc) · 4.42 KB
title Create remoteDesktopSecurityConfiguration
description Create a new remoteDesktopSecurityConfiguration object on the servicePrincipal.
author mjsantani
ms.localizationpriority medium
ms.subservice entra-applications
doc_type apiPageType
ms.date 01/02/2026

Create remoteDesktopSecurityConfiguration

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Create a new remoteDesktopSecurityConfiguration object on the servicePrincipal. Use this configuration to enable the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to authenticate a user to Microsoft Entra joined or Microsoft Entra hybrid joined devices.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

[!INCLUDE rbac-remote-desktop-security-config-apis]

HTTP request

You can address the service principal using either its id or appId. id and appId are referred to as the Object ID and Application (Client) ID, respectively, in app registrations in the Microsoft Entra admin center.

POST /servicePrincipals/{id}/remoteDesktopSecurityConfiguration
POST /servicePrincipals(appId='{appId}')/remoteDesktopSecurityConfiguration

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the remoteDesktopSecurityConfiguration object.

You can specify the following properties when creating a remoteDesktopSecurityConfiguration.

Property Type Description
isRemoteDesktopProtocolEnabled Boolean Whether new Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to authenticate a user to Microsoft Entra joined or Microsoft Entra hybrid joined devices over RDP is enabled or not. Required.

Response

If successful, this method returns a 201 Created response code and a remoteDesktopSecurityConfiguration object in the response body.

Examples

Request

The following example shows a request.

HTTP

POST https://graph.microsoft.com/beta/servicePrincipals/00af5dfb-85da-4b41-a677-0c6b86dd34f8/remoteDesktopSecurityConfiguration
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.remoteDesktopSecurityConfiguration",
  "isRemoteDesktopProtocolEnabled": true
}

JavaScript

[!INCLUDE sample-code] [!INCLUDE sdk-documentation]

Response

The following example shows the response.

HTTP/1.1 201 Created
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.remoteDesktopSecurityConfiguration",
  "id": "ca738153-c98a-f822-a7d1-5a6e1058462b",
  "isRemoteDesktopProtocolEnabled": true
}