Skip to content

remotedesktopsecurityconfiguration-get.md

Latest commit

 

History

History
94 lines (74 loc) · 3.87 KB

remotedesktopsecurityconfiguration-get.md

File metadata and controls

94 lines (74 loc) · 3.87 KB
title Get remoteDesktopSecurityConfiguration
description Read the properties and relationships of a remoteDesktopSecurityConfiguration object on a servicePrincipal.
author mjsantani
ms.localizationpriority medium
ms.subservice entra-applications
doc_type apiPageType
ms.date 01/02/2026

Get remoteDesktopSecurityConfiguration

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Read the properties and relationships of a remoteDesktopSecurityConfiguration object on a servicePrincipal. Use this configuration to view the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to authenticate a user to Microsoft Entra joined or Microsoft Entra hybrid joined devices. Additionally you can view any targetDeviceGroups that have been configured for SSO.

[!INCLUDE national-cloud-support]

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.

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

Optional query parameters

This method doesn't support any OData query parameters to help customize the response. For general information, see OData query parameters.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.

Request body

Don't supply a request body for this method.

Response

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

Examples

Request

The following example shows a request.

GET https://graph.microsoft.com/beta/servicePrincipals/00af5dfb-85da-4b41-a677-0c6b86dd34f8/remoteDesktopSecurityConfiguration

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.remoteDesktopSecurityConfiguration",
  "id": "ca738153-c98a-f822-a7d1-5a6e1058462b",
  "isRemoteDesktopProtocolEnabled": true,
  "targetDeviceGroups": [
    {
      "id": "1a9db3ab-0acf-4808-99ae-e8ed581cb2e0",
      "displayName": "Device Group A"
    }
  ]
}