openapi: 3.1.0 info: title: Microsoft Graph Admin Admin.admin servicePrincipals.remoteDesktopSecurityConfiguration API description: 'Microsoft Graph API for managing administrative resources in Microsoft Entra ID. This API enables administrators to manage Microsoft Edge browser settings, Internet Explorer mode configurations, site lists, shared browser sites, Microsoft 365 Apps installation options, people insights, service announcements, SharePoint settings, Copilot administration, directory administrative units, and admin consent policies.' version: 1.0.0 contact: name: Microsoft Graph API Support url: https://developer.microsoft.com/graph servers: - url: https://graph.microsoft.com/v1.0 description: Microsoft Graph API v1.0 endpoint tags: - name: servicePrincipals.remoteDesktopSecurityConfiguration x-ms-docs-toc-type: page paths: /servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration: description: Provides operations to manage the remoteDesktopSecurityConfiguration property of the microsoft.graph.servicePrincipal entity. parameters: - name: servicePrincipal-id in: path description: The unique identifier of servicePrincipal required: true schema: type: string x-ms-docs-key-type: servicePrincipal get: tags: - servicePrincipals.remoteDesktopSecurityConfiguration summary: Microsoft Graph Get remoteDesktopSecurityConfiguration description: 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. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/remotedesktopsecurityconfiguration-get?view=graph-rest-1.0 operationId: servicePrincipals.GetRemoteDesktopSecurityConfiguration parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.remoteDesktopSecurityConfiguration' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - servicePrincipals.remoteDesktopSecurityConfiguration summary: Microsoft Graph Update remoteDesktopSecurityConfiguration description: Update the properties of a remoteDesktopSecurityConfiguration object on the servicePrincipal. Use this configuration to enable or disable the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to authenticate a user to Microsoft Entra joined or Microsoft Entra hybrid joined devices. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/remotedesktopsecurityconfiguration-update?view=graph-rest-1.0 operationId: servicePrincipals.UpdateRemoteDesktopSecurityConfiguration requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.remoteDesktopSecurityConfiguration' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.remoteDesktopSecurityConfiguration' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - servicePrincipals.remoteDesktopSecurityConfiguration summary: Microsoft Graph Delete remoteDesktopSecurityConfiguration description: Delete a remoteDesktopSecurityConfiguration object on a servicePrincipal. Removing remoteDesktopSecurityConfiguration object on the servicePrincipal disables the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to authenticate a user to Microsoft Entra joined or Microsoft Entra hybrid joined devices, and removes any target device groups that you configured for SSO. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/serviceprincipal-delete-remotedesktopsecurityconfiguration?view=graph-rest-1.0 operationId: servicePrincipals.DeleteRemoteDesktopSecurityConfiguration parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/targetDeviceGroups: description: Provides operations to manage the targetDeviceGroups property of the microsoft.graph.remoteDesktopSecurityConfiguration entity. parameters: - name: servicePrincipal-id in: path description: The unique identifier of servicePrincipal required: true schema: type: string x-ms-docs-key-type: servicePrincipal get: tags: - servicePrincipals.remoteDesktopSecurityConfiguration summary: Microsoft Graph List targetDeviceGroups description: Get a list of the targetDeviceGroup objects and their properties on the remoteDesktopSecurityConfiguration resource on the servicePrincipal. Any user authenticating using the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to a Microsoft Entra joined or Microsoft Entra hybrid joined device that belongs to the targetDeviceGroup will get SSO. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/remotedesktopsecurityconfiguration-list-targetdevicegroups?view=graph-rest-1.0 operationId: servicePrincipals.remoteDesktopSecurityConfiguration.ListTargetDeviceGroups parameters: - $ref: '#/components/parameters/top' - $ref: '#/components/parameters/skip' - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' - $ref: '#/components/parameters/count' - name: $orderby in: query description: Order items by property values style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: $ref: '#/components/responses/microsoft.graph.targetDeviceGroupCollectionResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-pageable: nextLinkName: '@odata.nextLink' operationName: listMore x-ms-docs-operation-type: operation post: tags: - servicePrincipals.remoteDesktopSecurityConfiguration summary: Microsoft Graph Create targetDeviceGroup description: Create a new targetDeviceGroup object for the remoteDesktopSecurityConfiguration object on the servicePrincipal. You can configure a maximum of 10 target device groups for the remoteDesktopSecurityConfiguraiton object on the servicePrincipal. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/remotedesktopsecurityconfiguration-post-targetdevicegroups?view=graph-rest-1.0 operationId: servicePrincipals.remoteDesktopSecurityConfiguration.CreateTargetDeviceGroups requestBody: description: New navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.targetDeviceGroup' required: true responses: 2XX: description: Created navigation property. content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.targetDeviceGroup' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/targetDeviceGroups/{targetDeviceGroup-id}: description: Provides operations to manage the targetDeviceGroups property of the microsoft.graph.remoteDesktopSecurityConfiguration entity. parameters: - name: servicePrincipal-id in: path description: The unique identifier of servicePrincipal required: true schema: type: string x-ms-docs-key-type: servicePrincipal - name: targetDeviceGroup-id in: path description: The unique identifier of targetDeviceGroup required: true schema: type: string x-ms-docs-key-type: targetDeviceGroup get: tags: - servicePrincipals.remoteDesktopSecurityConfiguration summary: Microsoft Graph Get targetDeviceGroup description: Read the properties and relationships of a targetDeviceGroup object for the remoteDesktopSecurityConfiguration object on the servicePrincipal. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/targetdevicegroup-get?view=graph-rest-1.0 operationId: servicePrincipals.remoteDesktopSecurityConfiguration.GetTargetDeviceGroups parameters: - name: $select in: query description: Select properties to be returned style: form explode: false schema: uniqueItems: true type: array items: type: string - name: $expand in: query description: Expand related entities style: form explode: false schema: uniqueItems: true type: array items: type: string responses: 2XX: description: Retrieved navigation property content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.targetDeviceGroup' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation patch: tags: - servicePrincipals.remoteDesktopSecurityConfiguration summary: Microsoft Graph Update targetDeviceGroup description: Update the properties of a targetDeviceGroup object for remoteDesktopSecurityConfiguration object on the servicePrincipal. You can configure a maximum of 10 target device groups for the remoteDesktopSecurityConfiguraiton object on the servicePrincipal. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/targetdevicegroup-update?view=graph-rest-1.0 operationId: servicePrincipals.remoteDesktopSecurityConfiguration.UpdateTargetDeviceGroups requestBody: description: New navigation property values content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.targetDeviceGroup' required: true responses: 2XX: description: Success content: application/json: schema: $ref: '#/components/schemas/microsoft.graph.targetDeviceGroup' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation delete: tags: - servicePrincipals.remoteDesktopSecurityConfiguration summary: Microsoft Graph Delete targetDeviceGroup description: Delete a targetDeviceGroup object for the remoteDesktopSecurityConfiguration object on the servicePrincipal. Any user authenticating using the Microsoft Entra ID Remote Desktop Services (RDS) authentication protocol to a Microsoft Entra joined or Microsoft Entra hybrid joined device that's in the removed targetDeviceGroup doesn't get SSO prompts. externalDocs: description: Find more info here url: https://learn.microsoft.com/graph/api/remotedesktopsecurityconfiguration-delete-targetdevicegroups?view=graph-rest-1.0 operationId: servicePrincipals.remoteDesktopSecurityConfiguration.DeleteTargetDeviceGroups parameters: - name: If-Match in: header description: ETag schema: type: string responses: '204': description: Success 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' x-ms-docs-operation-type: operation /servicePrincipals/{servicePrincipal-id}/remoteDesktopSecurityConfiguration/targetDeviceGroups/$count: description: Provides operations to count the resources in the collection. parameters: - name: servicePrincipal-id in: path description: The unique identifier of servicePrincipal required: true schema: type: string x-ms-docs-key-type: servicePrincipal get: tags: - servicePrincipals.remoteDesktopSecurityConfiguration summary: Microsoft Graph Get the number of the resource operationId: servicePrincipals.remoteDesktopSecurityConfiguration.targetDeviceGroups.GetCount-51f5 parameters: - $ref: '#/components/parameters/search' - $ref: '#/components/parameters/filter' responses: 2XX: $ref: '#/components/responses/ODataCountResponse' 4XX: $ref: '#/components/responses/error' 5XX: $ref: '#/components/responses/error' components: schemas: microsoft.graph.ODataErrors.MainError: required: - code - message type: object properties: code: type: string message: type: string x-ms-primary-error-message: true target: type: string nullable: true details: type: array items: $ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails' innerError: $ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError' microsoft.graph.targetDeviceGroup: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - title: targetDeviceGroup required: - '@odata.type' type: object properties: displayName: type: string description: Display name for the target device group. nullable: true '@odata.type': type: string x-ms-discriminator-value: '#microsoft.graph.targetDeviceGroup' microsoft.graph.remoteDesktopSecurityConfiguration: allOf: - $ref: '#/components/schemas/microsoft.graph.entity' - title: remoteDesktopSecurityConfiguration required: - '@odata.type' type: object properties: isRemoteDesktopProtocolEnabled: type: boolean description: Determines if Microsoft Entra ID RDS authentication protocol for RDP is enabled. targetDeviceGroups: type: array items: $ref: '#/components/schemas/microsoft.graph.targetDeviceGroup' description: The collection of target device groups that are associated with the RDS security configuration that will be enabled for SSO when a client connects to the target device over RDP using the new Microsoft Entra ID RDS authentication protocol.