From 86429d0ede380bf9f66887ff016eb6d21b361e52 Mon Sep 17 00:00:00 2001 From: Laura Graham Date: Wed, 14 Feb 2024 19:02:04 -0800 Subject: [PATCH] Revert "[Intune Graph Document Management] - [2402] - Clear Extra/ Additional APIs Docs" --- ...faultteamsdevicenongmsenrollmentprofile.md | 98 ++++++++++++++ ...ntune-devices-manageddevice-createquery.md | 98 ++++++++++++++ ...e-rbac-operationapprovalrequest-approve.md | 87 ++++++++++++ ...operationapprovalrequest-cancelapproval.md | 87 ++++++++++++ ...perationapprovalrequest-cancelmyrequest.md | 79 +++++++++++ ...erationapprovalrequest-getmyrequestbyid.md | 124 ++++++++++++++++++ ...-operationapprovalrequest-getmyrequests.md | 119 +++++++++++++++++ ...erationapprovalrequest-getrequeststatus.md | 91 +++++++++++++ ...ne-rbac-operationapprovalrequest-reject.md | 87 ++++++++++++ ...-createremotehelpsessionresponse-create.md | 87 ++++++++++++ ...-createremotehelpsessionresponse-delete.md | 62 +++++++++ ...nce-createremotehelpsessionresponse-get.md | 75 +++++++++++ ...ce-createremotehelpsessionresponse-list.md | 74 +++++++++++ ...-createremotehelpsessionresponse-update.md | 87 ++++++++++++ ...ement-getallowedremoteassistanceactions.md | 78 +++++++++++ ...devicemanagement-reportremoteassistance.md | 102 ++++++++++++++ ...gement-reportremotehelpsessionstarttime.md | 77 +++++++++++ ...teassistancemonitoractivesessionsreport.md | 105 +++++++++++++++ ...teassistancemonitoravgsessiontimereport.md | 105 +++++++++++++++ ...oteassistancemonitortotalsessionsreport.md | 105 +++++++++++++++ ...-extendremotehelpsessionresponse-create.md | 93 +++++++++++++ ...-extendremotehelpsessionresponse-delete.md | 62 +++++++++ ...nce-extendremotehelpsessionresponse-get.md | 77 +++++++++++ ...ce-extendremotehelpsessionresponse-list.md | 76 +++++++++++ ...-extendremotehelpsessionresponse-update.md | 93 +++++++++++++ ...tremotehelpsessionaccessresponse-create.md | 93 +++++++++++++ ...tremotehelpsessionaccessresponse-delete.md | 62 +++++++++ ...uestremotehelpsessionaccessresponse-get.md | 77 +++++++++++ ...estremotehelpsessionaccessresponse-list.md | 76 +++++++++++ ...tremotehelpsessionaccessresponse-update.md | 93 +++++++++++++ ...etrieveremotehelpsessionresponse-create.md | 111 ++++++++++++++++ ...etrieveremotehelpsessionresponse-delete.md | 62 +++++++++ ...e-retrieveremotehelpsessionresponse-get.md | 83 ++++++++++++ ...-retrieveremotehelpsessionresponse-list.md | 82 ++++++++++++ ...etrieveremotehelpsessionresponse-update.md | 111 ++++++++++++++++ ...getautopilotdeploymentdeviceinformation.md | 105 +++++++++++++++ ...entreports-getautopilotdeploymentstatus.md | 105 +++++++++++++++ ...ts-retrieveautopilotdeploymentappdetail.md | 105 +++++++++++++++ ...retrieveautopilotdeploymentscriptdetail.md | 105 +++++++++++++++ ...work-encryptedprovisioningpackageextras.md | 44 +++++++ ...k-enrollmentprofilefornongmsteamsdevice.md | 51 +++++++ .../intune-devices-devicequeryresultstatus.md | 30 +++++ ...ne-rbac-operationapprovalpolicyplatform.md | 31 +++++ ...intune-rbac-operationapprovalpolicytype.md | 43 ++++++ ...ac-operationapprovalrequestentitystatus.md | 46 +++++++ ...une-rbac-operationapprovalrequeststatus.md | 30 +++++ ...sistance-allowedremoteassistanceactions.md | 27 ++++ ...istance-createremotehelpsessionresponse.md | 42 ++++++ ...istance-extendremotehelpsessionresponse.md | 46 +++++++ ...oteassistance-remoteassistancereporting.md | 84 ++++++++++++ ...eassistance-remoteassistancesessiontype.md | 26 ++++ ...-requestremotehelpsessionaccessresponse.md | 46 +++++++ ...tance-retrieveremotehelpsessionresponse.md | 58 ++++++++ ...entreports-getautopilotdeploymentstatus.md | 103 +++++++++++++++ 54 files changed, 4205 insertions(+) create mode 100644 api-reference/beta/api/intune-androidforwork-androiddeviceownerenrollmentprofile-getdefaultteamsdevicenongmsenrollmentprofile.md create mode 100644 api-reference/beta/api/intune-devices-manageddevice-createquery.md create mode 100644 api-reference/beta/api/intune-rbac-operationapprovalrequest-approve.md create mode 100644 api-reference/beta/api/intune-rbac-operationapprovalrequest-cancelapproval.md create mode 100644 api-reference/beta/api/intune-rbac-operationapprovalrequest-cancelmyrequest.md create mode 100644 api-reference/beta/api/intune-rbac-operationapprovalrequest-getmyrequestbyid.md create mode 100644 api-reference/beta/api/intune-rbac-operationapprovalrequest-getmyrequests.md create mode 100644 api-reference/beta/api/intune-rbac-operationapprovalrequest-getrequeststatus.md create mode 100644 api-reference/beta/api/intune-rbac-operationapprovalrequest-reject.md create mode 100644 api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-create.md create mode 100644 api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-delete.md create mode 100644 api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-get.md create mode 100644 api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-list.md create mode 100644 api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-update.md create mode 100644 api-reference/beta/api/intune-remoteassistance-devicemanagement-getallowedremoteassistanceactions.md create mode 100644 api-reference/beta/api/intune-remoteassistance-devicemanagement-reportremoteassistance.md create mode 100644 api-reference/beta/api/intune-remoteassistance-devicemanagement-reportremotehelpsessionstarttime.md create mode 100644 api-reference/beta/api/intune-remoteassistance-devicemanagementreports-getremoteassistancemonitoractivesessionsreport.md create mode 100644 api-reference/beta/api/intune-remoteassistance-devicemanagementreports-getremoteassistancemonitoravgsessiontimereport.md create mode 100644 api-reference/beta/api/intune-remoteassistance-devicemanagementreports-getremoteassistancemonitortotalsessionsreport.md create mode 100644 api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-create.md create mode 100644 api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-delete.md create mode 100644 api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-get.md create mode 100644 api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-list.md create mode 100644 api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-update.md create mode 100644 api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-create.md create mode 100644 api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-delete.md create mode 100644 api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-get.md create mode 100644 api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-list.md create mode 100644 api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-update.md create mode 100644 api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-create.md create mode 100644 api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-delete.md create mode 100644 api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-get.md create mode 100644 api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-list.md create mode 100644 api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-update.md create mode 100644 api-reference/beta/api/intune-reporting-devicemanagementreports-getautopilotdeploymentdeviceinformation.md create mode 100644 api-reference/beta/api/intune-reporting-devicemanagementreports-getautopilotdeploymentstatus.md create mode 100644 api-reference/beta/api/intune-reporting-devicemanagementreports-retrieveautopilotdeploymentappdetail.md create mode 100644 api-reference/beta/api/intune-reporting-devicemanagementreports-retrieveautopilotdeploymentscriptdetail.md create mode 100644 api-reference/beta/resources/intune-androidforwork-encryptedprovisioningpackageextras.md create mode 100644 api-reference/beta/resources/intune-androidforwork-enrollmentprofilefornongmsteamsdevice.md create mode 100644 api-reference/beta/resources/intune-devices-devicequeryresultstatus.md create mode 100644 api-reference/beta/resources/intune-rbac-operationapprovalpolicyplatform.md create mode 100644 api-reference/beta/resources/intune-rbac-operationapprovalpolicytype.md create mode 100644 api-reference/beta/resources/intune-rbac-operationapprovalrequestentitystatus.md create mode 100644 api-reference/beta/resources/intune-rbac-operationapprovalrequeststatus.md create mode 100644 api-reference/beta/resources/intune-remoteassistance-allowedremoteassistanceactions.md create mode 100644 api-reference/beta/resources/intune-remoteassistance-createremotehelpsessionresponse.md create mode 100644 api-reference/beta/resources/intune-remoteassistance-extendremotehelpsessionresponse.md create mode 100644 api-reference/beta/resources/intune-remoteassistance-remoteassistancereporting.md create mode 100644 api-reference/beta/resources/intune-remoteassistance-remoteassistancesessiontype.md create mode 100644 api-reference/beta/resources/intune-remoteassistance-requestremotehelpsessionaccessresponse.md create mode 100644 api-reference/beta/resources/intune-remoteassistance-retrieveremotehelpsessionresponse.md create mode 100644 api-reference/v1.0/api/intune-reporting-devicemanagementreports-getautopilotdeploymentstatus.md diff --git a/api-reference/beta/api/intune-androidforwork-androiddeviceownerenrollmentprofile-getdefaultteamsdevicenongmsenrollmentprofile.md b/api-reference/beta/api/intune-androidforwork-androiddeviceownerenrollmentprofile-getdefaultteamsdevicenongmsenrollmentprofile.md new file mode 100644 index 00000000000..4c6741275b2 --- /dev/null +++ b/api-reference/beta/api/intune-androidforwork-androiddeviceownerenrollmentprofile-getdefaultteamsdevicenongmsenrollmentprofile.md @@ -0,0 +1,98 @@ +--- +title: "getDefaultTeamsDeviceNonGmsEnrollmentProfile action" +description: "Intune Androidforwork Androiddeviceownerenrollmentprofile Getdefaultteamsdevicenongmsenrollmentprofile Api ." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# getDefaultTeamsDeviceNonGmsEnrollmentProfile action + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + + + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +POST /deviceManagement/androidDeviceOwnerEnrollmentProfiles/getDefaultTeamsDeviceNonGmsEnrollmentProfile +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply JSON representation of the parameters. + +The following table shows the parameters that can be used with this action. + +|Property|Type|Description| +|:---|:---|:---| +|enrollmentMode|[androidDeviceOwnerEnrollmentMode](../resources/intune-androidforwork-androiddeviceownerenrollmentmode.md)|| +|devicePublicKey|String|| +|userId|String|| + + + +## Response +If successful, this action returns a `200 OK` response code and a [enrollmentProfileForNonGmsTeamsDevice](../resources/intune-androidforwork-enrollmentprofilefornongmsteamsdevice.md) in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/androidDeviceOwnerEnrollmentProfiles/getDefaultTeamsDeviceNonGmsEnrollmentProfile + +Content-type: application/json +Content-length: 133 + +{ + "enrollmentMode": "corporateOwnedFullyManaged", + "devicePublicKey": "Device Public Key value", + "userId": "User Id value" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 505 + +{ + "value": { + "@odata.type": "microsoft.graph.enrollmentProfileForNonGmsTeamsDevice", + "accountId": "Account Id value", + "profileId": "Profile Id value", + "tokenExpirationDateTime": "2016-12-31T23:59:54.0590989-08:00", + "encryptedProvisioningPackageExtras": { + "@odata.type": "microsoft.graph.encryptedProvisioningPackageExtras", + "encryptedData": "ZW5jcnlwdGVkRGF0YQ==", + "encryptedSymmetricKey": "ZW5jcnlwdGVkU3ltbWV0cmljS2V5", + "iv": "aXY=" + } + } +} +``` diff --git a/api-reference/beta/api/intune-devices-manageddevice-createquery.md b/api-reference/beta/api/intune-devices-manageddevice-createquery.md new file mode 100644 index 00000000000..2677bd04c69 --- /dev/null +++ b/api-reference/beta/api/intune-devices-manageddevice-createquery.md @@ -0,0 +1,98 @@ +--- +title: "createQuery action" +description: "Allows user to send Intune Pivot device query to a managed device" +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# createQuery action + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Allows user to send Intune Pivot device query to a managed device + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementManagedDevices.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementManagedDevices.Read.All| + +## HTTP Request + +``` http +POST /deviceManagement/managedDevices/{managedDeviceId}/createQuery +POST /deviceManagement/comanagedDevices/{managedDeviceId}/createQuery +POST /deviceManagement/deviceHealthScripts/{deviceHealthScriptId}/deviceRunStates/{deviceHealthScriptDeviceStateId}/managedDevice/createQuery +POST /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/createQuery +POST /deviceManagement/deviceComplianceScripts/{deviceComplianceScriptId}/deviceRunStates/{deviceComplianceScriptDeviceStateId}/managedDevice/createQuery +POST /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/users/{userId}/managedDevices/{managedDeviceId}/createQuery +POST /deviceManagement/deviceManagementScripts/{deviceManagementScriptId}/deviceRunStates/{deviceManagementScriptDeviceStateId}/managedDevice/detectedApps/{detectedAppId}/managedDevices/{managedDeviceId}/createQuery +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply JSON representation of the parameters. + +The following table shows the parameters that can be used with this action. + +|Property|Type|Description| +|:---|:---|:---| +|query|String|| + + + +## Response +If successful, this action returns a `200 OK` response code and a [deviceQueryResult](../resources/intune-devices-devicequeryresult.md) in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/managedDevices/{managedDeviceId}/createQuery + +Content-type: application/json +Content-length: 30 + +{ + "query": "Query value" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 385 + +{ + "value": { + "@odata.type": "#microsoft.graph.deviceQueryResult", + "id": "71f84a70-4a70-71f8-704a-f871704af871", + "status": "notified", + "createdDateTime": "2017-01-01T00:02:43.5775965-08:00", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "returnCode": 10, + "errorMessage": "Error Message value", + "results": "Results value" + } +} +``` diff --git a/api-reference/beta/api/intune-rbac-operationapprovalrequest-approve.md b/api-reference/beta/api/intune-rbac-operationapprovalrequest-approve.md new file mode 100644 index 00000000000..3c71cdbe946 --- /dev/null +++ b/api-reference/beta/api/intune-rbac-operationapprovalrequest-approve.md @@ -0,0 +1,87 @@ +--- +title: "approve action" +description: "Approves the requested instance of an operationApprovalRequest." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# approve action + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Approves the requested instance of an operationApprovalRequest. + +[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementRBAC.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementRBAC.Read.All| + +## HTTP Request + +``` http +POST /deviceManagement/operationApprovalRequests/{operationApprovalRequestId}/approve +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply JSON representation of the parameters. + +The following table shows the parameters that can be used with this action. + +|Property|Type|Description| +|:---|:---|:---| +|justification|String|Indicates the justification for approving the request. Maximum length of justification is 1024 characters. For example: 'Approved per Change 23423 - needed for Feb 2023 application baseline updates.'| +|approvalSource|[operationApprovalSource](../resources/intune-rbac-operationapprovalsource.md)|Indicates the source of the action on the approval request. Possible values are: `unknown`, `adminConsole`, `email`. Default value is `unknown`.| + + + +## Response +If successful, this action returns a `200 OK` response code and a String in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/operationApprovalRequests/{operationApprovalRequestId}/approve + +Content-type: application/json +Content-length: 83 + +{ + "justification": "Justification value", + "approvalSource": "adminConsole" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 32 + +{ + "value": "Approve value" +} +``` diff --git a/api-reference/beta/api/intune-rbac-operationapprovalrequest-cancelapproval.md b/api-reference/beta/api/intune-rbac-operationapprovalrequest-cancelapproval.md new file mode 100644 index 00000000000..c17161d48af --- /dev/null +++ b/api-reference/beta/api/intune-rbac-operationapprovalrequest-cancelapproval.md @@ -0,0 +1,87 @@ +--- +title: "cancelApproval action" +description: "Cancels an already approved instance of an operationApprovalRequest." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# cancelApproval action + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Cancels an already approved instance of an operationApprovalRequest. + +[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementRBAC.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementRBAC.Read.All| + +## HTTP Request + +``` http +POST /deviceManagement/operationApprovalRequests/{operationApprovalRequestId}/cancelApproval +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply JSON representation of the parameters. + +The following table shows the parameters that can be used with this action. + +|Property|Type|Description| +|:---|:---|:---| +|justification|String|Indicates the justification for cancellation of a request that has already been approved. Maximum length of justification is 1024 characters. For example: 'Cancelled - Change 23423 no longer needed.'| +|approvalSource|[operationApprovalSource](../resources/intune-rbac-operationapprovalsource.md)|Indicates the source of the action on the approval request. Possible values are: `unknown`, `adminConsole`, `email`. Default value is `unknown`.| + + + +## Response +If successful, this action returns a `200 OK` response code and a String in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/operationApprovalRequests/{operationApprovalRequestId}/cancelApproval + +Content-type: application/json +Content-length: 83 + +{ + "justification": "Justification value", + "approvalSource": "adminConsole" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 40 + +{ + "value": "Cancel Approval value" +} +``` diff --git a/api-reference/beta/api/intune-rbac-operationapprovalrequest-cancelmyrequest.md b/api-reference/beta/api/intune-rbac-operationapprovalrequest-cancelmyrequest.md new file mode 100644 index 00000000000..ed3c7a8171b --- /dev/null +++ b/api-reference/beta/api/intune-rbac-operationapprovalrequest-cancelmyrequest.md @@ -0,0 +1,79 @@ +--- +title: "cancelMyRequest action" +description: "Intune Rbac Operationapprovalrequest Cancelmyrequest Api ." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# cancelMyRequest action + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + + + +[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementRBAC.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementRBAC.Read.All| + +## HTTP Request + +``` http +POST /deviceManagement/operationApprovalRequests/cancelMyRequest +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply JSON representation of the parameters. + +The following table shows the parameters that can be used with this action. + +|Property|Type|Description| +|:---|:---|:---| +|id|String|| + + + +## Response +If successful, this action returns a `204 No Content` response code. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/operationApprovalRequests/cancelMyRequest + +Content-type: application/json +Content-length: 24 + +{ + "id": "Id value" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 204 No Content +``` diff --git a/api-reference/beta/api/intune-rbac-operationapprovalrequest-getmyrequestbyid.md b/api-reference/beta/api/intune-rbac-operationapprovalrequest-getmyrequestbyid.md new file mode 100644 index 00000000000..665f45cf44e --- /dev/null +++ b/api-reference/beta/api/intune-rbac-operationapprovalrequest-getmyrequestbyid.md @@ -0,0 +1,124 @@ +--- +title: "getMyRequestById function" +description: "Intune Rbac Operationapprovalrequest Getmyrequestbyid Api ." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# getMyRequestById function + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + + + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementRBAC.Read.All, DeviceManagementRBAC.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementRBAC.Read.All, DeviceManagementRBAC.ReadWrite.All| + +## HTTP Request + +``` http +GET /deviceManagement/operationApprovalRequests/getMyRequestById +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request URL, provide the following query parameters with values. +The following table shows the parameters that can be used with this function. + +|Property|Type|Description| +|:---|:---|:---| +|id|String|| + + + +## Response +If successful, this function returns a `200 OK` response code and a [operationApprovalRequest](../resources/intune-rbac-operationapprovalrequest.md) in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/deviceManagement/operationApprovalRequests/getMyRequestById(id='parameterValue') +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 1712 + +{ + "value": { + "@odata.type": "#microsoft.graph.operationApprovalRequest", + "id": "4e9eed82-ed82-4e9e-82ed-9e4e82ed9e4e", + "requestDateTime": "2017-01-01T00:03:07.1589002-08:00", + "expirationDateTime": "2016-12-31T23:57:57.2481234-08:00", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "requestor": { + "@odata.type": "microsoft.graph.identitySet", + "application": { + "@odata.type": "microsoft.graph.identity", + "id": "Id value", + "displayName": "Display Name value" + }, + "device": { + "@odata.type": "microsoft.graph.identity", + "id": "Id value", + "displayName": "Display Name value" + }, + "user": { + "@odata.type": "microsoft.graph.identity", + "id": "Id value", + "displayName": "Display Name value" + } + }, + "approver": { + "@odata.type": "microsoft.graph.identitySet", + "application": { + "@odata.type": "microsoft.graph.identity", + "id": "Id value", + "displayName": "Display Name value" + }, + "device": { + "@odata.type": "microsoft.graph.identity", + "id": "Id value", + "displayName": "Display Name value" + }, + "user": { + "@odata.type": "microsoft.graph.identity", + "id": "Id value", + "displayName": "Display Name value" + } + }, + "status": "needsApproval", + "requestJustification": "Request Justification value", + "approvalJustification": "Approval Justification value", + "operationApprovalPolicies": "Operation Approval Policies value", + "requiredOperationApprovalPolicyTypes": [ + "deviceWipe" + ] + } +} +``` diff --git a/api-reference/beta/api/intune-rbac-operationapprovalrequest-getmyrequests.md b/api-reference/beta/api/intune-rbac-operationapprovalrequest-getmyrequests.md new file mode 100644 index 00000000000..8c2bcb30f7a --- /dev/null +++ b/api-reference/beta/api/intune-rbac-operationapprovalrequest-getmyrequests.md @@ -0,0 +1,119 @@ +--- +title: "getMyRequests function" +description: "Intune Rbac Operationapprovalrequest Getmyrequests Api ." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# getMyRequests function + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + + + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementRBAC.Read.All, DeviceManagementRBAC.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementRBAC.Read.All, DeviceManagementRBAC.ReadWrite.All| + +## HTTP Request + +``` http +GET /deviceManagement/operationApprovalRequests/getMyRequests +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +Do not supply a request body for this method. + +## Response +If successful, this function returns a `200 OK` response code and a [operationApprovalRequest](../resources/intune-rbac-operationapprovalrequest.md) collection in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/deviceManagement/operationApprovalRequests/getMyRequests +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 1822 + +{ + "value": [ + { + "@odata.type": "#microsoft.graph.operationApprovalRequest", + "id": "4e9eed82-ed82-4e9e-82ed-9e4e82ed9e4e", + "requestDateTime": "2017-01-01T00:03:07.1589002-08:00", + "expirationDateTime": "2016-12-31T23:57:57.2481234-08:00", + "lastModifiedDateTime": "2017-01-01T00:00:35.1329464-08:00", + "requestor": { + "@odata.type": "microsoft.graph.identitySet", + "application": { + "@odata.type": "microsoft.graph.identity", + "id": "Id value", + "displayName": "Display Name value" + }, + "device": { + "@odata.type": "microsoft.graph.identity", + "id": "Id value", + "displayName": "Display Name value" + }, + "user": { + "@odata.type": "microsoft.graph.identity", + "id": "Id value", + "displayName": "Display Name value" + } + }, + "approver": { + "@odata.type": "microsoft.graph.identitySet", + "application": { + "@odata.type": "microsoft.graph.identity", + "id": "Id value", + "displayName": "Display Name value" + }, + "device": { + "@odata.type": "microsoft.graph.identity", + "id": "Id value", + "displayName": "Display Name value" + }, + "user": { + "@odata.type": "microsoft.graph.identity", + "id": "Id value", + "displayName": "Display Name value" + } + }, + "status": "needsApproval", + "requestJustification": "Request Justification value", + "approvalJustification": "Approval Justification value", + "operationApprovalPolicies": "Operation Approval Policies value", + "requiredOperationApprovalPolicyTypes": [ + "deviceWipe" + ] + } + ] +} +``` diff --git a/api-reference/beta/api/intune-rbac-operationapprovalrequest-getrequeststatus.md b/api-reference/beta/api/intune-rbac-operationapprovalrequest-getrequeststatus.md new file mode 100644 index 00000000000..1cc62ac7d6a --- /dev/null +++ b/api-reference/beta/api/intune-rbac-operationapprovalrequest-getrequeststatus.md @@ -0,0 +1,91 @@ +--- +title: "getRequestStatus action" +description: "Intune Rbac Operationapprovalrequest Getrequeststatus Api ." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# getRequestStatus action + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + + + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementRBAC.Read.All, DeviceManagementRBAC.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementRBAC.Read.All, DeviceManagementRBAC.ReadWrite.All| + +## HTTP Request + +``` http +POST /deviceManagement/operationApprovalRequests/getRequestStatus +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply JSON representation of the parameters. + +The following table shows the parameters that can be used with this action. + +|Property|Type|Description| +|:---|:---|:---| +|entityId|String|| +|entityType|String|| + + + +## Response +If successful, this action returns a `200 OK` response code and a [operationApprovalRequestEntityStatus](../resources/intune-rbac-operationapprovalrequestentitystatus.md) in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/operationApprovalRequests/getRequestStatus + +Content-type: application/json +Content-length: 75 + +{ + "entityId": "Entity Id value", + "entityType": "Entity Type value" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 273 + +{ + "value": { + "@odata.type": "microsoft.graph.operationApprovalRequestEntityStatus", + "requestId": "Request Id value", + "requestExpirationDateTime": "2016-12-31T23:58:57.6373767-08:00", + "requestStatus": "needsApproval", + "entityLocked": true + } +} +``` diff --git a/api-reference/beta/api/intune-rbac-operationapprovalrequest-reject.md b/api-reference/beta/api/intune-rbac-operationapprovalrequest-reject.md new file mode 100644 index 00000000000..a246b6df75f --- /dev/null +++ b/api-reference/beta/api/intune-rbac-operationapprovalrequest-reject.md @@ -0,0 +1,87 @@ +--- +title: "reject action" +description: "Rejects the requested instance of an operationApprovalRequest." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# reject action + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Rejects the requested instance of an operationApprovalRequest. + +[!INCLUDE [national-cloud-support](../../includes/all-clouds.md)] + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementRBAC.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementRBAC.Read.All| + +## HTTP Request + +``` http +POST /deviceManagement/operationApprovalRequests/{operationApprovalRequestId}/reject +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply JSON representation of the parameters. + +The following table shows the parameters that can be used with this action. + +|Property|Type|Description| +|:---|:---|:---| +|justification|String|Indicates the justification for rejecting the request. Maximum length of justification is 1024 characters. For example: 'Rejected - Change 23423 no longer needed.'| +|approvalSource|[operationApprovalSource](../resources/intune-rbac-operationapprovalsource.md)|Indicates the source of the action on the approval request. Possible values are: `unknown`, `adminConsole`, `email`. Default value is `unknown`.| + + + +## Response +If successful, this action returns a `200 OK` response code and a String in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/operationApprovalRequests/{operationApprovalRequestId}/reject + +Content-type: application/json +Content-length: 83 + +{ + "justification": "Justification value", + "approvalSource": "adminConsole" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 31 + +{ + "value": "Reject value" +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-create.md b/api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-create.md new file mode 100644 index 00000000000..5486c61dbbb --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-create.md @@ -0,0 +1,87 @@ +--- +title: "Create createRemoteHelpSessionResponse" +description: "Create a new createRemoteHelpSessionResponse object." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# Create createRemoteHelpSessionResponse + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Create a new [createRemoteHelpSessionResponse](../resources/intune-remoteassistance-createremotehelpsessionresponse.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +POST /CreateRemoteHelpSessionResponse +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply a JSON representation for the createRemoteHelpSessionResponse object. + +The following table shows the properties that are required when you create the createRemoteHelpSessionResponse. + +|Property|Type|Description| +|:---|:---|:---| +|sessionKey|String|The unique identifier for a session| +|sessionType|[allowedRemoteAssistanceActions](../resources/intune-remoteassistance-allowedremoteassistanceactions.md)|Remote Help Session Type. Possible values are: `viewScreen`, `takeFullControl`, `elevation`, `unattended`, `unknownFutureValue`.| + + + +## Response +If successful, this method returns a `201 Created` response code and a [createRemoteHelpSessionResponse](../resources/intune-remoteassistance-createremotehelpsessionresponse.md) object in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/CreateRemoteHelpSessionResponse +Content-type: application/json +Content-length: 148 + +{ + "@odata.type": "#microsoft.graph.createRemoteHelpSessionResponse", + "sessionKey": "Session Key value", + "sessionType": "takeFullControl" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 201 Created +Content-Type: application/json +Content-Length: 148 + +{ + "@odata.type": "#microsoft.graph.createRemoteHelpSessionResponse", + "sessionKey": "Session Key value", + "sessionType": "takeFullControl" +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-delete.md b/api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-delete.md new file mode 100644 index 00000000000..f4154c344c4 --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-delete.md @@ -0,0 +1,62 @@ +--- +title: "Delete createRemoteHelpSessionResponse" +description: "Deletes a createRemoteHelpSessionResponse." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# Delete createRemoteHelpSessionResponse + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Deletes a [createRemoteHelpSessionResponse](../resources/intune-remoteassistance-createremotehelpsessionresponse.md). + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +DELETE /CreateRemoteHelpSessionResponse/{CreateRemoteHelpSessionResponseId} +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +Do not supply a request body for this method. + +## Response +If successful, this method returns a `204 No Content` response code. + +## Example + +### Request +Here is an example of the request. +``` http +DELETE https://graph.microsoft.com/beta/CreateRemoteHelpSessionResponse/{CreateRemoteHelpSessionResponseId} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 204 No Content +``` diff --git a/api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-get.md b/api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-get.md new file mode 100644 index 00000000000..8b1ae521fec --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-get.md @@ -0,0 +1,75 @@ +--- +title: "Get createRemoteHelpSessionResponse" +description: "Read properties and relationships of the createRemoteHelpSessionResponse object." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# Get createRemoteHelpSessionResponse + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Read properties and relationships of the [createRemoteHelpSessionResponse](../resources/intune-remoteassistance-createremotehelpsessionresponse.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +GET /CreateRemoteHelpSessionResponse/{CreateRemoteHelpSessionResponseId} +``` + +## Optional query parameters +This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +Do not supply a request body for this method. + +## Response +If successful, this method returns a `200 OK` response code and [createRemoteHelpSessionResponse](../resources/intune-remoteassistance-createremotehelpsessionresponse.md) object in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/CreateRemoteHelpSessionResponse/{CreateRemoteHelpSessionResponseId} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 173 + +{ + "value": { + "@odata.type": "#microsoft.graph.createRemoteHelpSessionResponse", + "sessionKey": "Session Key value", + "sessionType": "takeFullControl" + } +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-list.md b/api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-list.md new file mode 100644 index 00000000000..7ab6ba66cbd --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-list.md @@ -0,0 +1,74 @@ +--- +title: "List createRemoteHelpSessionResponses" +description: "List properties and relationships of the createRemoteHelpSessionResponse objects." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# List createRemoteHelpSessionResponses + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +List properties and relationships of the [createRemoteHelpSessionResponse](../resources/intune-remoteassistance-createremotehelpsessionresponse.md) objects. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +GET /CreateRemoteHelpSessionResponse +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +Do not supply a request body for this method. + +## Response +If successful, this method returns a `200 OK` response code and a collection of [createRemoteHelpSessionResponse](../resources/intune-remoteassistance-createremotehelpsessionresponse.md) objects in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/CreateRemoteHelpSessionResponse +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 193 + +{ + "value": [ + { + "@odata.type": "#microsoft.graph.createRemoteHelpSessionResponse", + "sessionKey": "Session Key value", + "sessionType": "takeFullControl" + } + ] +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-update.md b/api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-update.md new file mode 100644 index 00000000000..0de012f914c --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-createremotehelpsessionresponse-update.md @@ -0,0 +1,87 @@ +--- +title: "Update createRemoteHelpSessionResponse" +description: "Update the properties of a createRemoteHelpSessionResponse object." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# Update createRemoteHelpSessionResponse + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Update the properties of a [createRemoteHelpSessionResponse](../resources/intune-remoteassistance-createremotehelpsessionresponse.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +PATCH /CreateRemoteHelpSessionResponse/{CreateRemoteHelpSessionResponseId} +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply a JSON representation for the [createRemoteHelpSessionResponse](../resources/intune-remoteassistance-createremotehelpsessionresponse.md) object. + +The following table shows the properties that are required when you create the [createRemoteHelpSessionResponse](../resources/intune-remoteassistance-createremotehelpsessionresponse.md). + +|Property|Type|Description| +|:---|:---|:---| +|sessionKey|String|The unique identifier for a session| +|sessionType|[allowedRemoteAssistanceActions](../resources/intune-remoteassistance-allowedremoteassistanceactions.md)|Remote Help Session Type. Possible values are: `viewScreen`, `takeFullControl`, `elevation`, `unattended`, `unknownFutureValue`.| + + + +## Response +If successful, this method returns a `200 OK` response code and an updated [createRemoteHelpSessionResponse](../resources/intune-remoteassistance-createremotehelpsessionresponse.md) object in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +PATCH https://graph.microsoft.com/beta/CreateRemoteHelpSessionResponse/{CreateRemoteHelpSessionResponseId} +Content-type: application/json +Content-length: 148 + +{ + "@odata.type": "#microsoft.graph.createRemoteHelpSessionResponse", + "sessionKey": "Session Key value", + "sessionType": "takeFullControl" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 148 + +{ + "@odata.type": "#microsoft.graph.createRemoteHelpSessionResponse", + "sessionKey": "Session Key value", + "sessionType": "takeFullControl" +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-devicemanagement-getallowedremoteassistanceactions.md b/api-reference/beta/api/intune-remoteassistance-devicemanagement-getallowedremoteassistanceactions.md new file mode 100644 index 00000000000..110605e7ef4 --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-devicemanagement-getallowedremoteassistanceactions.md @@ -0,0 +1,78 @@ +--- +title: "getAllowedRemoteAssistanceActions function" +description: "Intune Remoteassistance Devicemanagement Getallowedremoteassistanceactions Api ." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# getAllowedRemoteAssistanceActions function + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + + + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +GET /deviceManagement/getAllowedRemoteAssistanceActions +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request URL, provide the following query parameters with values. +The following table shows the parameters that can be used with this function. + +|Property|Type|Description| +|:---|:---|:---| +|sharerAadDeviceId|String|| +|sharerDeviceIntuneMDMEnrolled|Boolean|| +|sharerId|String|| +|sharerTenantId|String|| + + + +## Response +If successful, this function returns a `200 OK` response code and a [allowedRemoteAssistanceActions](../resources/intune-remoteassistance-allowedremoteassistanceactions.md) in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/deviceManagement/getAllowedRemoteAssistanceActions(sharerAadDeviceId='parameterValue',sharerDeviceIntuneMDMEnrolled=True,sharerId='parameterValue',sharerTenantId='parameterValue') +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 34 + +{ + "value": "takeFullControl" +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-devicemanagement-reportremoteassistance.md b/api-reference/beta/api/intune-remoteassistance-devicemanagement-reportremoteassistance.md new file mode 100644 index 00000000000..126a7bc22e3 --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-devicemanagement-reportremoteassistance.md @@ -0,0 +1,102 @@ +--- +title: "reportRemoteAssistance action" +description: "A post call to submit the reporting payload" +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# reportRemoteAssistance action + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +A post call to submit the reporting payload + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.Read.All, DeviceManagementConfiguration.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.Read.All, DeviceManagementConfiguration.Read.All| + +## HTTP Request + +``` http +POST /deviceManagement/reportRemoteAssistance +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply JSON representation of the parameters. + +The following table shows the parameters that can be used with this action. + +|Property|Type|Description| +|:---|:---|:---| +|reportingPayload|[remoteAssistanceReporting](../resources/intune-remoteassistance-remoteassistancereporting.md)|| + + + +## Response +If successful, this action returns a `204 No Content` response code. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/reportRemoteAssistance + +Content-type: application/json +Content-length: 1195 + +{ + "reportingPayload": { + "@odata.type": "microsoft.graph.remoteAssistanceReporting", + "id": "Id value", + "startDateTime": "2016-12-31T23:58:46.7156189-08:00", + "endDateTime": "2017-01-01T00:03:30.9241974-08:00", + "remoteAssistanceSessionType": "fullControl", + "helperEmail": "Helper Email value", + "helperTenantId": "Helper Tenant Id value", + "helperUserId": "Helper User Id value", + "helperFirstName": "Helper First Name value", + "helperLastName": "Helper Last Name value", + "helperOs": "Helper Os value", + "deviceId": "Device Id value", + "helperDeviceAadId": "Helper Device Aad Id value", + "helperDeviceName": "Helper Device Name value", + "helperEnrollmentState": "enrolled", + "sharerEmail": "Sharer Email value", + "sharerTenantId": "Sharer Tenant Id value", + "sharerFirstName": "Sharer First Name value", + "sharerLastName": "Sharer Last Name value", + "sharerDeviceAadId": "Sharer Device Aad Id value", + "sharerDeviceName": "Sharer Device Name value", + "sharerOs": "Sharer Os value", + "sharerEnrollmentState": "enrolled", + "sharerDeviceSerialNumber": "Sharer Device Serial Number value" + } +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 204 No Content +``` diff --git a/api-reference/beta/api/intune-remoteassistance-devicemanagement-reportremotehelpsessionstarttime.md b/api-reference/beta/api/intune-remoteassistance-devicemanagement-reportremotehelpsessionstarttime.md new file mode 100644 index 00000000000..7a1d037c8c6 --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-devicemanagement-reportremotehelpsessionstarttime.md @@ -0,0 +1,77 @@ +--- +title: "reportRemoteHelpSessionStartTime action" +description: "Intune Remoteassistance Devicemanagement Reportremotehelpsessionstarttime Api ." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# reportRemoteHelpSessionStartTime action + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + + + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.Read.All, DeviceManagementConfiguration.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.Read.All, DeviceManagementConfiguration.Read.All| + +## HTTP Request + +``` http +POST /deviceManagement/reportRemoteHelpSessionStartTime +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply JSON representation of the parameters. + +The following table shows the parameters that can be used with this action. + +|Property|Type|Description| +|:---|:---|:---| +|sessionId|String|| + + + +## Response +If successful, this action returns a `204 No Content` response code. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/reportRemoteHelpSessionStartTime + +Content-type: application/json +Content-length: 39 + +{ + "sessionId": "Session Id value" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 204 No Content +``` diff --git a/api-reference/beta/api/intune-remoteassistance-devicemanagementreports-getremoteassistancemonitoractivesessionsreport.md b/api-reference/beta/api/intune-remoteassistance-devicemanagementreports-getremoteassistancemonitoractivesessionsreport.md new file mode 100644 index 00000000000..6a773602d57 --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-devicemanagementreports-getremoteassistancemonitoractivesessionsreport.md @@ -0,0 +1,105 @@ +--- +title: "getRemoteAssistanceMonitorActiveSessionsReport action" +description: "Intune Remoteassistance Devicemanagementreports Getremoteassistancemonitoractivesessionsreport Api ." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# getRemoteAssistanceMonitorActiveSessionsReport action + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + + + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +POST /deviceManagement/reports/getRemoteAssistanceMonitorActiveSessionsReport +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply JSON representation of the parameters. + +The following table shows the parameters that can be used with this action. + +|Property|Type|Description| +|:---|:---|:---| +|name|String|| +|select|String collection|| +|search|String|| +|groupBy|String collection|| +|orderBy|String collection|| +|skip|Int32|| +|top|Int32|| +|sessionId|String|| +|filter|String|| + + + +## Response +If successful, this action returns a `200 OK` response code and a Stream in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/reports/getRemoteAssistanceMonitorActiveSessionsReport + +Content-type: application/json +Content-length: 278 + +{ + "name": "Name value", + "select": [ + "Select value" + ], + "search": "Search value", + "groupBy": [ + "Group By value" + ], + "orderBy": [ + "Order By value" + ], + "skip": 4, + "top": 3, + "sessionId": "Session Id value", + "filter": "Filter value" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 119 + +{ + "value": "Z2V0UmVtb3RlQXNzaXN0YW5jZU1vbml0b3JBY3RpdmVTZXNzaW9uc1JlcG9ydCBJbnR1bmUgRG9jIFNhbXBsZSA3Mjc0MTA5OTE=" +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-devicemanagementreports-getremoteassistancemonitoravgsessiontimereport.md b/api-reference/beta/api/intune-remoteassistance-devicemanagementreports-getremoteassistancemonitoravgsessiontimereport.md new file mode 100644 index 00000000000..24d9f623211 --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-devicemanagementreports-getremoteassistancemonitoravgsessiontimereport.md @@ -0,0 +1,105 @@ +--- +title: "getRemoteAssistanceMonitorAvgSessionTimeReport action" +description: "Intune Remoteassistance Devicemanagementreports Getremoteassistancemonitoravgsessiontimereport Api ." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# getRemoteAssistanceMonitorAvgSessionTimeReport action + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + + + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +POST /deviceManagement/reports/getRemoteAssistanceMonitorAvgSessionTimeReport +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply JSON representation of the parameters. + +The following table shows the parameters that can be used with this action. + +|Property|Type|Description| +|:---|:---|:---| +|name|String|| +|select|String collection|| +|search|String|| +|groupBy|String collection|| +|orderBy|String collection|| +|skip|Int32|| +|top|Int32|| +|sessionId|String|| +|filter|String|| + + + +## Response +If successful, this action returns a `200 OK` response code and a Stream in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/reports/getRemoteAssistanceMonitorAvgSessionTimeReport + +Content-type: application/json +Content-length: 278 + +{ + "name": "Name value", + "select": [ + "Select value" + ], + "search": "Search value", + "groupBy": [ + "Group By value" + ], + "orderBy": [ + "Order By value" + ], + "skip": 4, + "top": 3, + "sessionId": "Session Id value", + "filter": "Filter value" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 123 + +{ + "value": "Z2V0UmVtb3RlQXNzaXN0YW5jZU1vbml0b3JBdmdTZXNzaW9uVGltZVJlcG9ydCBJbnR1bmUgRG9jIFNhbXBsZSAtMTUzNDAwMDU5OQ==" +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-devicemanagementreports-getremoteassistancemonitortotalsessionsreport.md b/api-reference/beta/api/intune-remoteassistance-devicemanagementreports-getremoteassistancemonitortotalsessionsreport.md new file mode 100644 index 00000000000..4fc079626fe --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-devicemanagementreports-getremoteassistancemonitortotalsessionsreport.md @@ -0,0 +1,105 @@ +--- +title: "getRemoteAssistanceMonitorTotalSessionsReport action" +description: "Intune Remoteassistance Devicemanagementreports Getremoteassistancemonitortotalsessionsreport Api ." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# getRemoteAssistanceMonitorTotalSessionsReport action + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + + + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +POST /deviceManagement/reports/getRemoteAssistanceMonitorTotalSessionsReport +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply JSON representation of the parameters. + +The following table shows the parameters that can be used with this action. + +|Property|Type|Description| +|:---|:---|:---| +|name|String|| +|select|String collection|| +|search|String|| +|groupBy|String collection|| +|orderBy|String collection|| +|skip|Int32|| +|top|Int32|| +|sessionId|String|| +|filter|String|| + + + +## Response +If successful, this action returns a `200 OK` response code and a Stream in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/reports/getRemoteAssistanceMonitorTotalSessionsReport + +Content-type: application/json +Content-length: 278 + +{ + "name": "Name value", + "select": [ + "Select value" + ], + "search": "Search value", + "groupBy": [ + "Group By value" + ], + "orderBy": [ + "Order By value" + ], + "skip": 4, + "top": 3, + "sessionId": "Session Id value", + "filter": "Filter value" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 119 + +{ + "value": "Z2V0UmVtb3RlQXNzaXN0YW5jZU1vbml0b3JUb3RhbFNlc3Npb25zUmVwb3J0IEludHVuZSBEb2MgU2FtcGxlIDIwNDgyNjQ4ODE=" +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-create.md b/api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-create.md new file mode 100644 index 00000000000..699cb3729e6 --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-create.md @@ -0,0 +1,93 @@ +--- +title: "Create extendRemoteHelpSessionResponse" +description: "Create a new extendRemoteHelpSessionResponse object." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# Create extendRemoteHelpSessionResponse + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Create a new [extendRemoteHelpSessionResponse](../resources/intune-remoteassistance-extendremotehelpsessionresponse.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +POST /ExtendRemoteHelpSessionResponse +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply a JSON representation for the extendRemoteHelpSessionResponse object. + +The following table shows the properties that are required when you create the extendRemoteHelpSessionResponse. + +|Property|Type|Description| +|:---|:---|:---| +|sessionKey|String|The unique identifier for a session| +|acsHelperUserToken|String|Helper ACS User Token| +|pubSubHelperAccessUri|String|Azure Pubsub Group Id| +|sessionExpirationDateTime|DateTimeOffset|Azure Pubsub Session Expiration Date Time.| + + + +## Response +If successful, this method returns a `201 Created` response code and a [extendRemoteHelpSessionResponse](../resources/intune-remoteassistance-extendremotehelpsessionresponse.md) object in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/ExtendRemoteHelpSessionResponse +Content-type: application/json +Content-length: 299 + +{ + "@odata.type": "#microsoft.graph.extendRemoteHelpSessionResponse", + "sessionKey": "Session Key value", + "acsHelperUserToken": "Acs Helper User Token value", + "pubSubHelperAccessUri": "Pub Sub Helper Access Uri value", + "sessionExpirationDateTime": "2016-12-31T23:59:57.5564522-08:00" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 201 Created +Content-Type: application/json +Content-Length: 299 + +{ + "@odata.type": "#microsoft.graph.extendRemoteHelpSessionResponse", + "sessionKey": "Session Key value", + "acsHelperUserToken": "Acs Helper User Token value", + "pubSubHelperAccessUri": "Pub Sub Helper Access Uri value", + "sessionExpirationDateTime": "2016-12-31T23:59:57.5564522-08:00" +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-delete.md b/api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-delete.md new file mode 100644 index 00000000000..c1b23635357 --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-delete.md @@ -0,0 +1,62 @@ +--- +title: "Delete extendRemoteHelpSessionResponse" +description: "Deletes a extendRemoteHelpSessionResponse." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# Delete extendRemoteHelpSessionResponse + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Deletes a [extendRemoteHelpSessionResponse](../resources/intune-remoteassistance-extendremotehelpsessionresponse.md). + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +DELETE /ExtendRemoteHelpSessionResponse/{ExtendRemoteHelpSessionResponseId} +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +Do not supply a request body for this method. + +## Response +If successful, this method returns a `204 No Content` response code. + +## Example + +### Request +Here is an example of the request. +``` http +DELETE https://graph.microsoft.com/beta/ExtendRemoteHelpSessionResponse/{ExtendRemoteHelpSessionResponseId} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 204 No Content +``` diff --git a/api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-get.md b/api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-get.md new file mode 100644 index 00000000000..1b1be8c44db --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-get.md @@ -0,0 +1,77 @@ +--- +title: "Get extendRemoteHelpSessionResponse" +description: "Read properties and relationships of the extendRemoteHelpSessionResponse object." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# Get extendRemoteHelpSessionResponse + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Read properties and relationships of the [extendRemoteHelpSessionResponse](../resources/intune-remoteassistance-extendremotehelpsessionresponse.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +GET /ExtendRemoteHelpSessionResponse/{ExtendRemoteHelpSessionResponseId} +``` + +## Optional query parameters +This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +Do not supply a request body for this method. + +## Response +If successful, this method returns a `200 OK` response code and [extendRemoteHelpSessionResponse](../resources/intune-remoteassistance-extendremotehelpsessionresponse.md) object in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/ExtendRemoteHelpSessionResponse/{ExtendRemoteHelpSessionResponseId} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 328 + +{ + "value": { + "@odata.type": "#microsoft.graph.extendRemoteHelpSessionResponse", + "sessionKey": "Session Key value", + "acsHelperUserToken": "Acs Helper User Token value", + "pubSubHelperAccessUri": "Pub Sub Helper Access Uri value", + "sessionExpirationDateTime": "2016-12-31T23:59:57.5564522-08:00" + } +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-list.md b/api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-list.md new file mode 100644 index 00000000000..f0409e6f407 --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-list.md @@ -0,0 +1,76 @@ +--- +title: "List extendRemoteHelpSessionResponses" +description: "List properties and relationships of the extendRemoteHelpSessionResponse objects." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# List extendRemoteHelpSessionResponses + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +List properties and relationships of the [extendRemoteHelpSessionResponse](../resources/intune-remoteassistance-extendremotehelpsessionresponse.md) objects. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +GET /ExtendRemoteHelpSessionResponse +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +Do not supply a request body for this method. + +## Response +If successful, this method returns a `200 OK` response code and a collection of [extendRemoteHelpSessionResponse](../resources/intune-remoteassistance-extendremotehelpsessionresponse.md) objects in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/ExtendRemoteHelpSessionResponse +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 352 + +{ + "value": [ + { + "@odata.type": "#microsoft.graph.extendRemoteHelpSessionResponse", + "sessionKey": "Session Key value", + "acsHelperUserToken": "Acs Helper User Token value", + "pubSubHelperAccessUri": "Pub Sub Helper Access Uri value", + "sessionExpirationDateTime": "2016-12-31T23:59:57.5564522-08:00" + } + ] +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-update.md b/api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-update.md new file mode 100644 index 00000000000..14c2a0b749f --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-extendremotehelpsessionresponse-update.md @@ -0,0 +1,93 @@ +--- +title: "Update extendRemoteHelpSessionResponse" +description: "Update the properties of a extendRemoteHelpSessionResponse object." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# Update extendRemoteHelpSessionResponse + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Update the properties of a [extendRemoteHelpSessionResponse](../resources/intune-remoteassistance-extendremotehelpsessionresponse.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +PATCH /ExtendRemoteHelpSessionResponse/{ExtendRemoteHelpSessionResponseId} +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply a JSON representation for the [extendRemoteHelpSessionResponse](../resources/intune-remoteassistance-extendremotehelpsessionresponse.md) object. + +The following table shows the properties that are required when you create the [extendRemoteHelpSessionResponse](../resources/intune-remoteassistance-extendremotehelpsessionresponse.md). + +|Property|Type|Description| +|:---|:---|:---| +|sessionKey|String|The unique identifier for a session| +|acsHelperUserToken|String|Helper ACS User Token| +|pubSubHelperAccessUri|String|Azure Pubsub Group Id| +|sessionExpirationDateTime|DateTimeOffset|Azure Pubsub Session Expiration Date Time.| + + + +## Response +If successful, this method returns a `200 OK` response code and an updated [extendRemoteHelpSessionResponse](../resources/intune-remoteassistance-extendremotehelpsessionresponse.md) object in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +PATCH https://graph.microsoft.com/beta/ExtendRemoteHelpSessionResponse/{ExtendRemoteHelpSessionResponseId} +Content-type: application/json +Content-length: 299 + +{ + "@odata.type": "#microsoft.graph.extendRemoteHelpSessionResponse", + "sessionKey": "Session Key value", + "acsHelperUserToken": "Acs Helper User Token value", + "pubSubHelperAccessUri": "Pub Sub Helper Access Uri value", + "sessionExpirationDateTime": "2016-12-31T23:59:57.5564522-08:00" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 299 + +{ + "@odata.type": "#microsoft.graph.extendRemoteHelpSessionResponse", + "sessionKey": "Session Key value", + "acsHelperUserToken": "Acs Helper User Token value", + "pubSubHelperAccessUri": "Pub Sub Helper Access Uri value", + "sessionExpirationDateTime": "2016-12-31T23:59:57.5564522-08:00" +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-create.md b/api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-create.md new file mode 100644 index 00000000000..82282dbce55 --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-create.md @@ -0,0 +1,93 @@ +--- +title: "Create requestRemoteHelpSessionAccessResponse" +description: "Create a new requestRemoteHelpSessionAccessResponse object." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# Create requestRemoteHelpSessionAccessResponse + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Create a new [requestRemoteHelpSessionAccessResponse](../resources/intune-remoteassistance-requestremotehelpsessionaccessresponse.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +POST /RequestRemoteHelpSessionAccessResponse +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply a JSON representation for the requestRemoteHelpSessionAccessResponse object. + +The following table shows the properties that are required when you create the requestRemoteHelpSessionAccessResponse. + +|Property|Type|Description| +|:---|:---|:---| +|sessionKey|String|The unique identifier for a session| +|sessionType|[allowedRemoteAssistanceActions](../resources/intune-remoteassistance-allowedremoteassistanceactions.md)|Remote Help Session Type. Possible values are: `viewScreen`, `takeFullControl`, `elevation`, `unattended`, `unknownFutureValue`.| +|pubSubEncryptionKey|String|The unique identifier for encrypting client messages sent to PubSub| +|pubSubEncryption|String|AES encryption Initialization Vector for encrypting client messages sent to PubSub| + + + +## Response +If successful, this method returns a `201 Created` response code and a [requestRemoteHelpSessionAccessResponse](../resources/intune-remoteassistance-requestremotehelpsessionaccessresponse.md) object in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/RequestRemoteHelpSessionAccessResponse +Content-type: application/json +Content-length: 264 + +{ + "@odata.type": "#microsoft.graph.requestRemoteHelpSessionAccessResponse", + "sessionKey": "Session Key value", + "sessionType": "takeFullControl", + "pubSubEncryptionKey": "Pub Sub Encryption Key value", + "pubSubEncryption": "Pub Sub Encryption value" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 201 Created +Content-Type: application/json +Content-Length: 264 + +{ + "@odata.type": "#microsoft.graph.requestRemoteHelpSessionAccessResponse", + "sessionKey": "Session Key value", + "sessionType": "takeFullControl", + "pubSubEncryptionKey": "Pub Sub Encryption Key value", + "pubSubEncryption": "Pub Sub Encryption value" +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-delete.md b/api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-delete.md new file mode 100644 index 00000000000..ac2abcfef2b --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-delete.md @@ -0,0 +1,62 @@ +--- +title: "Delete requestRemoteHelpSessionAccessResponse" +description: "Deletes a requestRemoteHelpSessionAccessResponse." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# Delete requestRemoteHelpSessionAccessResponse + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Deletes a [requestRemoteHelpSessionAccessResponse](../resources/intune-remoteassistance-requestremotehelpsessionaccessresponse.md). + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +DELETE /RequestRemoteHelpSessionAccessResponse/{RequestRemoteHelpSessionAccessResponseId} +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +Do not supply a request body for this method. + +## Response +If successful, this method returns a `204 No Content` response code. + +## Example + +### Request +Here is an example of the request. +``` http +DELETE https://graph.microsoft.com/beta/RequestRemoteHelpSessionAccessResponse/{RequestRemoteHelpSessionAccessResponseId} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 204 No Content +``` diff --git a/api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-get.md b/api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-get.md new file mode 100644 index 00000000000..656c58c1a03 --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-get.md @@ -0,0 +1,77 @@ +--- +title: "Get requestRemoteHelpSessionAccessResponse" +description: "Read properties and relationships of the requestRemoteHelpSessionAccessResponse object." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# Get requestRemoteHelpSessionAccessResponse + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Read properties and relationships of the [requestRemoteHelpSessionAccessResponse](../resources/intune-remoteassistance-requestremotehelpsessionaccessresponse.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +GET /RequestRemoteHelpSessionAccessResponse/{RequestRemoteHelpSessionAccessResponseId} +``` + +## Optional query parameters +This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +Do not supply a request body for this method. + +## Response +If successful, this method returns a `200 OK` response code and [requestRemoteHelpSessionAccessResponse](../resources/intune-remoteassistance-requestremotehelpsessionaccessresponse.md) object in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/RequestRemoteHelpSessionAccessResponse/{RequestRemoteHelpSessionAccessResponseId} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 293 + +{ + "value": { + "@odata.type": "#microsoft.graph.requestRemoteHelpSessionAccessResponse", + "sessionKey": "Session Key value", + "sessionType": "takeFullControl", + "pubSubEncryptionKey": "Pub Sub Encryption Key value", + "pubSubEncryption": "Pub Sub Encryption value" + } +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-list.md b/api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-list.md new file mode 100644 index 00000000000..338f97601b4 --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-list.md @@ -0,0 +1,76 @@ +--- +title: "List requestRemoteHelpSessionAccessResponses" +description: "List properties and relationships of the requestRemoteHelpSessionAccessResponse objects." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# List requestRemoteHelpSessionAccessResponses + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +List properties and relationships of the [requestRemoteHelpSessionAccessResponse](../resources/intune-remoteassistance-requestremotehelpsessionaccessresponse.md) objects. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +GET /RequestRemoteHelpSessionAccessResponse +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +Do not supply a request body for this method. + +## Response +If successful, this method returns a `200 OK` response code and a collection of [requestRemoteHelpSessionAccessResponse](../resources/intune-remoteassistance-requestremotehelpsessionaccessresponse.md) objects in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/RequestRemoteHelpSessionAccessResponse +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 317 + +{ + "value": [ + { + "@odata.type": "#microsoft.graph.requestRemoteHelpSessionAccessResponse", + "sessionKey": "Session Key value", + "sessionType": "takeFullControl", + "pubSubEncryptionKey": "Pub Sub Encryption Key value", + "pubSubEncryption": "Pub Sub Encryption value" + } + ] +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-update.md b/api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-update.md new file mode 100644 index 00000000000..e4134eeb423 --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-requestremotehelpsessionaccessresponse-update.md @@ -0,0 +1,93 @@ +--- +title: "Update requestRemoteHelpSessionAccessResponse" +description: "Update the properties of a requestRemoteHelpSessionAccessResponse object." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# Update requestRemoteHelpSessionAccessResponse + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Update the properties of a [requestRemoteHelpSessionAccessResponse](../resources/intune-remoteassistance-requestremotehelpsessionaccessresponse.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +PATCH /RequestRemoteHelpSessionAccessResponse/{RequestRemoteHelpSessionAccessResponseId} +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply a JSON representation for the [requestRemoteHelpSessionAccessResponse](../resources/intune-remoteassistance-requestremotehelpsessionaccessresponse.md) object. + +The following table shows the properties that are required when you create the [requestRemoteHelpSessionAccessResponse](../resources/intune-remoteassistance-requestremotehelpsessionaccessresponse.md). + +|Property|Type|Description| +|:---|:---|:---| +|sessionKey|String|The unique identifier for a session| +|sessionType|[allowedRemoteAssistanceActions](../resources/intune-remoteassistance-allowedremoteassistanceactions.md)|Remote Help Session Type. Possible values are: `viewScreen`, `takeFullControl`, `elevation`, `unattended`, `unknownFutureValue`.| +|pubSubEncryptionKey|String|The unique identifier for encrypting client messages sent to PubSub| +|pubSubEncryption|String|AES encryption Initialization Vector for encrypting client messages sent to PubSub| + + + +## Response +If successful, this method returns a `200 OK` response code and an updated [requestRemoteHelpSessionAccessResponse](../resources/intune-remoteassistance-requestremotehelpsessionaccessresponse.md) object in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +PATCH https://graph.microsoft.com/beta/RequestRemoteHelpSessionAccessResponse/{RequestRemoteHelpSessionAccessResponseId} +Content-type: application/json +Content-length: 264 + +{ + "@odata.type": "#microsoft.graph.requestRemoteHelpSessionAccessResponse", + "sessionKey": "Session Key value", + "sessionType": "takeFullControl", + "pubSubEncryptionKey": "Pub Sub Encryption Key value", + "pubSubEncryption": "Pub Sub Encryption value" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 264 + +{ + "@odata.type": "#microsoft.graph.requestRemoteHelpSessionAccessResponse", + "sessionKey": "Session Key value", + "sessionType": "takeFullControl", + "pubSubEncryptionKey": "Pub Sub Encryption Key value", + "pubSubEncryption": "Pub Sub Encryption value" +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-create.md b/api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-create.md new file mode 100644 index 00000000000..d5077e9b8e7 --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-create.md @@ -0,0 +1,111 @@ +--- +title: "Create retrieveRemoteHelpSessionResponse" +description: "Create a new retrieveRemoteHelpSessionResponse object." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# Create retrieveRemoteHelpSessionResponse + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Create a new [retrieveRemoteHelpSessionResponse](../resources/intune-remoteassistance-retrieveremotehelpsessionresponse.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +POST /RemoteHelpSessionRetrieveResponse +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply a JSON representation for the retrieveRemoteHelpSessionResponse object. + +The following table shows the properties that are required when you create the retrieveRemoteHelpSessionResponse. + +|Property|Type|Description| +|:---|:---|:---| +|sessionKey|String|The unique identifier for a session| +|acsHelperUserToken|String|Helper ACS User Token| +|acsHelperUserId|String|Helper ACS User Id| +|acsSharerUserId|String|Sharer ACS User Id| +|acsGroupId|String|ACS Group Id| +|sessionType|[allowedRemoteAssistanceActions](../resources/intune-remoteassistance-allowedremoteassistanceactions.md)|Remote Help Session Type. Possible values are: `viewScreen`, `takeFullControl`, `elevation`, `unattended`, `unknownFutureValue`.| +|deviceName|String|Android Device Name| +|pubSubGroupId|String|Azure Pubsub Group Id| +|pubSubHelperAccessUri|String|Azure Pubsub Group Id| +|sessionExpirationDateTime|DateTimeOffset|Azure Pubsub Session Expiration Date Time.| + + + +## Response +If successful, this method returns a `201 Created` response code and a [retrieveRemoteHelpSessionResponse](../resources/intune-remoteassistance-retrieveremotehelpsessionresponse.md) object in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/RemoteHelpSessionRetrieveResponse +Content-type: application/json +Content-length: 561 + +{ + "@odata.type": "#microsoft.graph.retrieveRemoteHelpSessionResponse", + "sessionKey": "Session Key value", + "acsHelperUserToken": "Acs Helper User Token value", + "acsHelperUserId": "Acs Helper User Id value", + "acsSharerUserId": "Acs Sharer User Id value", + "acsGroupId": "Acs Group Id value", + "sessionType": "takeFullControl", + "deviceName": "Device Name value", + "pubSubGroupId": "Pub Sub Group Id value", + "pubSubHelperAccessUri": "Pub Sub Helper Access Uri value", + "sessionExpirationDateTime": "2016-12-31T23:59:57.5564522-08:00" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 201 Created +Content-Type: application/json +Content-Length: 561 + +{ + "@odata.type": "#microsoft.graph.retrieveRemoteHelpSessionResponse", + "sessionKey": "Session Key value", + "acsHelperUserToken": "Acs Helper User Token value", + "acsHelperUserId": "Acs Helper User Id value", + "acsSharerUserId": "Acs Sharer User Id value", + "acsGroupId": "Acs Group Id value", + "sessionType": "takeFullControl", + "deviceName": "Device Name value", + "pubSubGroupId": "Pub Sub Group Id value", + "pubSubHelperAccessUri": "Pub Sub Helper Access Uri value", + "sessionExpirationDateTime": "2016-12-31T23:59:57.5564522-08:00" +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-delete.md b/api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-delete.md new file mode 100644 index 00000000000..ccef3f88724 --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-delete.md @@ -0,0 +1,62 @@ +--- +title: "Delete retrieveRemoteHelpSessionResponse" +description: "Deletes a retrieveRemoteHelpSessionResponse." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# Delete retrieveRemoteHelpSessionResponse + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Deletes a [retrieveRemoteHelpSessionResponse](../resources/intune-remoteassistance-retrieveremotehelpsessionresponse.md). + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +DELETE /RemoteHelpSessionRetrieveResponse/{RemoteHelpSessionRetrieveResponseId} +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +Do not supply a request body for this method. + +## Response +If successful, this method returns a `204 No Content` response code. + +## Example + +### Request +Here is an example of the request. +``` http +DELETE https://graph.microsoft.com/beta/RemoteHelpSessionRetrieveResponse/{RemoteHelpSessionRetrieveResponseId} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 204 No Content +``` diff --git a/api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-get.md b/api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-get.md new file mode 100644 index 00000000000..1b9b8944f18 --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-get.md @@ -0,0 +1,83 @@ +--- +title: "Get retrieveRemoteHelpSessionResponse" +description: "Read properties and relationships of the retrieveRemoteHelpSessionResponse object." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# Get retrieveRemoteHelpSessionResponse + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Read properties and relationships of the [retrieveRemoteHelpSessionResponse](../resources/intune-remoteassistance-retrieveremotehelpsessionresponse.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +GET /RemoteHelpSessionRetrieveResponse/{RemoteHelpSessionRetrieveResponseId} +``` + +## Optional query parameters +This method supports the [OData Query Parameters](/graph/query-parameters) to help customize the response. + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +Do not supply a request body for this method. + +## Response +If successful, this method returns a `200 OK` response code and [retrieveRemoteHelpSessionResponse](../resources/intune-remoteassistance-retrieveremotehelpsessionresponse.md) object in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/RemoteHelpSessionRetrieveResponse/{RemoteHelpSessionRetrieveResponseId} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 602 + +{ + "value": { + "@odata.type": "#microsoft.graph.retrieveRemoteHelpSessionResponse", + "sessionKey": "Session Key value", + "acsHelperUserToken": "Acs Helper User Token value", + "acsHelperUserId": "Acs Helper User Id value", + "acsSharerUserId": "Acs Sharer User Id value", + "acsGroupId": "Acs Group Id value", + "sessionType": "takeFullControl", + "deviceName": "Device Name value", + "pubSubGroupId": "Pub Sub Group Id value", + "pubSubHelperAccessUri": "Pub Sub Helper Access Uri value", + "sessionExpirationDateTime": "2016-12-31T23:59:57.5564522-08:00" + } +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-list.md b/api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-list.md new file mode 100644 index 00000000000..df46acdf7e5 --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-list.md @@ -0,0 +1,82 @@ +--- +title: "List retrieveRemoteHelpSessionResponses" +description: "List properties and relationships of the retrieveRemoteHelpSessionResponse objects." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# List retrieveRemoteHelpSessionResponses + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +List properties and relationships of the [retrieveRemoteHelpSessionResponse](../resources/intune-remoteassistance-retrieveremotehelpsessionresponse.md) objects. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.Read.All, DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +GET /RemoteHelpSessionRetrieveResponse +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +Do not supply a request body for this method. + +## Response +If successful, this method returns a `200 OK` response code and a collection of [retrieveRemoteHelpSessionResponse](../resources/intune-remoteassistance-retrieveremotehelpsessionresponse.md) objects in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +GET https://graph.microsoft.com/beta/RemoteHelpSessionRetrieveResponse +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 638 + +{ + "value": [ + { + "@odata.type": "#microsoft.graph.retrieveRemoteHelpSessionResponse", + "sessionKey": "Session Key value", + "acsHelperUserToken": "Acs Helper User Token value", + "acsHelperUserId": "Acs Helper User Id value", + "acsSharerUserId": "Acs Sharer User Id value", + "acsGroupId": "Acs Group Id value", + "sessionType": "takeFullControl", + "deviceName": "Device Name value", + "pubSubGroupId": "Pub Sub Group Id value", + "pubSubHelperAccessUri": "Pub Sub Helper Access Uri value", + "sessionExpirationDateTime": "2016-12-31T23:59:57.5564522-08:00" + } + ] +} +``` diff --git a/api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-update.md b/api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-update.md new file mode 100644 index 00000000000..6cee50f845c --- /dev/null +++ b/api-reference/beta/api/intune-remoteassistance-retrieveremotehelpsessionresponse-update.md @@ -0,0 +1,111 @@ +--- +title: "Update retrieveRemoteHelpSessionResponse" +description: "Update the properties of a retrieveRemoteHelpSessionResponse object." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# Update retrieveRemoteHelpSessionResponse + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Update the properties of a [retrieveRemoteHelpSessionResponse](../resources/intune-remoteassistance-retrieveremotehelpsessionresponse.md) object. + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementServiceConfig.ReadWrite.All, DeviceManagementConfiguration.ReadWrite.All| + +## HTTP Request + +``` http +PATCH /RemoteHelpSessionRetrieveResponse/{RemoteHelpSessionRetrieveResponseId} +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply a JSON representation for the [retrieveRemoteHelpSessionResponse](../resources/intune-remoteassistance-retrieveremotehelpsessionresponse.md) object. + +The following table shows the properties that are required when you create the [retrieveRemoteHelpSessionResponse](../resources/intune-remoteassistance-retrieveremotehelpsessionresponse.md). + +|Property|Type|Description| +|:---|:---|:---| +|sessionKey|String|The unique identifier for a session| +|acsHelperUserToken|String|Helper ACS User Token| +|acsHelperUserId|String|Helper ACS User Id| +|acsSharerUserId|String|Sharer ACS User Id| +|acsGroupId|String|ACS Group Id| +|sessionType|[allowedRemoteAssistanceActions](../resources/intune-remoteassistance-allowedremoteassistanceactions.md)|Remote Help Session Type. Possible values are: `viewScreen`, `takeFullControl`, `elevation`, `unattended`, `unknownFutureValue`.| +|deviceName|String|Android Device Name| +|pubSubGroupId|String|Azure Pubsub Group Id| +|pubSubHelperAccessUri|String|Azure Pubsub Group Id| +|sessionExpirationDateTime|DateTimeOffset|Azure Pubsub Session Expiration Date Time.| + + + +## Response +If successful, this method returns a `200 OK` response code and an updated [retrieveRemoteHelpSessionResponse](../resources/intune-remoteassistance-retrieveremotehelpsessionresponse.md) object in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +PATCH https://graph.microsoft.com/beta/RemoteHelpSessionRetrieveResponse/{RemoteHelpSessionRetrieveResponseId} +Content-type: application/json +Content-length: 561 + +{ + "@odata.type": "#microsoft.graph.retrieveRemoteHelpSessionResponse", + "sessionKey": "Session Key value", + "acsHelperUserToken": "Acs Helper User Token value", + "acsHelperUserId": "Acs Helper User Id value", + "acsSharerUserId": "Acs Sharer User Id value", + "acsGroupId": "Acs Group Id value", + "sessionType": "takeFullControl", + "deviceName": "Device Name value", + "pubSubGroupId": "Pub Sub Group Id value", + "pubSubHelperAccessUri": "Pub Sub Helper Access Uri value", + "sessionExpirationDateTime": "2016-12-31T23:59:57.5564522-08:00" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 561 + +{ + "@odata.type": "#microsoft.graph.retrieveRemoteHelpSessionResponse", + "sessionKey": "Session Key value", + "acsHelperUserToken": "Acs Helper User Token value", + "acsHelperUserId": "Acs Helper User Id value", + "acsSharerUserId": "Acs Sharer User Id value", + "acsGroupId": "Acs Group Id value", + "sessionType": "takeFullControl", + "deviceName": "Device Name value", + "pubSubGroupId": "Pub Sub Group Id value", + "pubSubHelperAccessUri": "Pub Sub Helper Access Uri value", + "sessionExpirationDateTime": "2016-12-31T23:59:57.5564522-08:00" +} +``` diff --git a/api-reference/beta/api/intune-reporting-devicemanagementreports-getautopilotdeploymentdeviceinformation.md b/api-reference/beta/api/intune-reporting-devicemanagementreports-getautopilotdeploymentdeviceinformation.md new file mode 100644 index 00000000000..02fa602084f --- /dev/null +++ b/api-reference/beta/api/intune-reporting-devicemanagementreports-getautopilotdeploymentdeviceinformation.md @@ -0,0 +1,105 @@ +--- +title: "getAutopilotDeploymentDeviceInformation action" +description: "Intune Reporting Devicemanagementreports Getautopilotdeploymentdeviceinformation Api ." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# getAutopilotDeploymentDeviceInformation action + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + + + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| + +## HTTP Request + +``` http +POST /deviceManagement/reports/getAutopilotDeploymentDeviceInformation +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply JSON representation of the parameters. + +The following table shows the parameters that can be used with this action. + +|Property|Type|Description| +|:---|:---|:---| +|name|String|| +|select|String collection|| +|search|String|| +|groupBy|String collection|| +|orderBy|String collection|| +|skip|Int32|| +|top|Int32|| +|sessionId|String|| +|filter|String|| + + + +## Response +If successful, this action returns a `200 OK` response code and a Stream in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/reports/getAutopilotDeploymentDeviceInformation + +Content-type: application/json +Content-length: 278 + +{ + "name": "Name value", + "select": [ + "Select value" + ], + "search": "Search value", + "groupBy": [ + "Group By value" + ], + "orderBy": [ + "Order By value" + ], + "skip": 4, + "top": 3, + "sessionId": "Session Id value", + "filter": "Filter value" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 111 + +{ + "value": "Z2V0QXV0b3BpbG90RGVwbG95bWVudERldmljZUluZm9ybWF0aW9uIEludHVuZSBEb2MgU2FtcGxlIC04NTgzMDIwNg==" +} +``` diff --git a/api-reference/beta/api/intune-reporting-devicemanagementreports-getautopilotdeploymentstatus.md b/api-reference/beta/api/intune-reporting-devicemanagementreports-getautopilotdeploymentstatus.md new file mode 100644 index 00000000000..6e4b3235a2a --- /dev/null +++ b/api-reference/beta/api/intune-reporting-devicemanagementreports-getautopilotdeploymentstatus.md @@ -0,0 +1,105 @@ +--- +title: "getAutopilotDeploymentStatus action" +description: "Intune Reporting Devicemanagementreports Getautopilotdeploymentstatus Api ." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# getAutopilotDeploymentStatus action + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + + + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| + +## HTTP Request + +``` http +POST /deviceManagement/reports/getAutopilotDeploymentStatus +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply JSON representation of the parameters. + +The following table shows the parameters that can be used with this action. + +|Property|Type|Description| +|:---|:---|:---| +|name|String|| +|select|String collection|| +|search|String|| +|groupBy|String collection|| +|orderBy|String collection|| +|skip|Int32|| +|top|Int32|| +|sessionId|String|| +|filter|String|| + + + +## Response +If successful, this action returns a `200 OK` response code and a Stream in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/reports/getAutopilotDeploymentStatus + +Content-type: application/json +Content-length: 278 + +{ + "name": "Name value", + "select": [ + "Select value" + ], + "search": "Search value", + "groupBy": [ + "Group By value" + ], + "orderBy": [ + "Order By value" + ], + "skip": 4, + "top": 3, + "sessionId": "Session Id value", + "filter": "Filter value" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 99 + +{ + "value": "Z2V0QXV0b3BpbG90RGVwbG95bWVudFN0YXR1cyBJbnR1bmUgRG9jIFNhbXBsZSAtMTQwMDQ1MDU5Mg==" +} +``` diff --git a/api-reference/beta/api/intune-reporting-devicemanagementreports-retrieveautopilotdeploymentappdetail.md b/api-reference/beta/api/intune-reporting-devicemanagementreports-retrieveautopilotdeploymentappdetail.md new file mode 100644 index 00000000000..0caaff2655d --- /dev/null +++ b/api-reference/beta/api/intune-reporting-devicemanagementreports-retrieveautopilotdeploymentappdetail.md @@ -0,0 +1,105 @@ +--- +title: "retrieveAutopilotDeploymentAppDetail action" +description: "Intune Reporting Devicemanagementreports Retrieveautopilotdeploymentappdetail Api ." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# retrieveAutopilotDeploymentAppDetail action + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + + + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementApps.Read.All, DeviceManagementManagedDevices.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementApps.Read.All, DeviceManagementManagedDevices.Read.All| + +## HTTP Request + +``` http +POST /deviceManagement/reports/retrieveAutopilotDeploymentAppDetail +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply JSON representation of the parameters. + +The following table shows the parameters that can be used with this action. + +|Property|Type|Description| +|:---|:---|:---| +|name|String|| +|select|String collection|| +|search|String|| +|groupBy|String collection|| +|orderBy|String collection|| +|skip|Int32|| +|top|Int32|| +|sessionId|String|| +|filter|String|| + + + +## Response +If successful, this action returns a `200 OK` response code and a Stream in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/reports/retrieveAutopilotDeploymentAppDetail + +Content-type: application/json +Content-length: 278 + +{ + "name": "Name value", + "select": [ + "Select value" + ], + "search": "Search value", + "groupBy": [ + "Group By value" + ], + "orderBy": [ + "Order By value" + ], + "skip": 4, + "top": 3, + "sessionId": "Session Id value", + "filter": "Filter value" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 107 + +{ + "value": "cmV0cmlldmVBdXRvcGlsb3REZXBsb3ltZW50QXBwRGV0YWlsIEludHVuZSBEb2MgU2FtcGxlIC05MDU4MjAyNjg=" +} +``` diff --git a/api-reference/beta/api/intune-reporting-devicemanagementreports-retrieveautopilotdeploymentscriptdetail.md b/api-reference/beta/api/intune-reporting-devicemanagementreports-retrieveautopilotdeploymentscriptdetail.md new file mode 100644 index 00000000000..4ea195e76f8 --- /dev/null +++ b/api-reference/beta/api/intune-reporting-devicemanagementreports-retrieveautopilotdeploymentscriptdetail.md @@ -0,0 +1,105 @@ +--- +title: "retrieveAutopilotDeploymentScriptDetail action" +description: "Intune Reporting Devicemanagementreports Retrieveautopilotdeploymentscriptdetail Api ." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# retrieveAutopilotDeploymentScriptDetail action + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + + + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementApps.Read.All, DeviceManagementManagedDevices.Read.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementApps.Read.All, DeviceManagementManagedDevices.Read.All| + +## HTTP Request + +``` http +POST /deviceManagement/reports/retrieveAutopilotDeploymentScriptDetail +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply JSON representation of the parameters. + +The following table shows the parameters that can be used with this action. + +|Property|Type|Description| +|:---|:---|:---| +|name|String|| +|select|String collection|| +|search|String|| +|groupBy|String collection|| +|orderBy|String collection|| +|skip|Int32|| +|top|Int32|| +|sessionId|String|| +|filter|String|| + + + +## Response +If successful, this action returns a `200 OK` response code and a Stream in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/beta/deviceManagement/reports/retrieveAutopilotDeploymentScriptDetail + +Content-type: application/json +Content-length: 278 + +{ + "name": "Name value", + "select": [ + "Select value" + ], + "search": "Search value", + "groupBy": [ + "Group By value" + ], + "orderBy": [ + "Order By value" + ], + "skip": 4, + "top": 3, + "sessionId": "Session Id value", + "filter": "Filter value" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 111 + +{ + "value": "cmV0cmlldmVBdXRvcGlsb3REZXBsb3ltZW50U2NyaXB0RGV0YWlsIEludHVuZSBEb2MgU2FtcGxlIC05NzUxMTEyNTI=" +} +``` diff --git a/api-reference/beta/resources/intune-androidforwork-encryptedprovisioningpackageextras.md b/api-reference/beta/resources/intune-androidforwork-encryptedprovisioningpackageextras.md new file mode 100644 index 00000000000..6d7071a2f76 --- /dev/null +++ b/api-reference/beta/resources/intune-androidforwork-encryptedprovisioningpackageextras.md @@ -0,0 +1,44 @@ +--- +title: "encryptedProvisioningPackageExtras resource type" +description: "Encrypted provisioning package extras for Teams devices." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: resourcePageType +--- + +# encryptedProvisioningPackageExtras resource type + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Encrypted provisioning package extras for Teams devices. + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|encryptedData|Binary|Data Encrypted with the symmetric key.| +|encryptedSymmetricKey|Binary|Symmetric Key used to encrypt the data returned. Encrypted with a public key.| +|iv|Binary|Initialization Vector used to encrypt the data returned.| + +## Relationships +None + +## JSON Representation +Here is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.encryptedProvisioningPackageExtras", + "encryptedData": "binary", + "encryptedSymmetricKey": "binary", + "iv": "binary" +} +``` diff --git a/api-reference/beta/resources/intune-androidforwork-enrollmentprofilefornongmsteamsdevice.md b/api-reference/beta/resources/intune-androidforwork-enrollmentprofilefornongmsteamsdevice.md new file mode 100644 index 00000000000..27e42cd37df --- /dev/null +++ b/api-reference/beta/resources/intune-androidforwork-enrollmentprofilefornongmsteamsdevice.md @@ -0,0 +1,51 @@ +--- +title: "enrollmentProfileForNonGmsTeamsDevice resource type" +description: "Enrollment Profile used to enroll Android Open Source Project Teams devices." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: resourcePageType +--- + +# enrollmentProfileForNonGmsTeamsDevice resource type + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Enrollment Profile used to enroll Android Open Source Project Teams devices. + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|accountId|String|Tenant GUID the enrollment profile belongs to.| +|profileId|String|Unique GUID for the enrollment profile.| +|tokenExpirationDateTime|DateTimeOffset|Date time the most recently created token will expire.| +|encryptedProvisioningPackageExtras|[encryptedProvisioningPackageExtras](../resources/intune-androidforwork-encryptedprovisioningpackageextras.md)|Encrypted base-64 string that contains the provisioning package extras| + +## Relationships +None + +## JSON Representation +Here is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.enrollmentProfileForNonGmsTeamsDevice", + "accountId": "String", + "profileId": "String", + "tokenExpirationDateTime": "String (timestamp)", + "encryptedProvisioningPackageExtras": { + "@odata.type": "microsoft.graph.encryptedProvisioningPackageExtras", + "encryptedData": "binary", + "encryptedSymmetricKey": "binary", + "iv": "binary" + } +} +``` diff --git a/api-reference/beta/resources/intune-devices-devicequeryresultstatus.md b/api-reference/beta/resources/intune-devices-devicequeryresultstatus.md new file mode 100644 index 00000000000..b74066d4193 --- /dev/null +++ b/api-reference/beta/resources/intune-devices-devicequeryresultstatus.md @@ -0,0 +1,30 @@ +--- +title: "deviceQueryResultStatus enum type" +description: "Status of Intune Pivot device query." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: enumPageType +--- + +# deviceQueryResultStatus enum type + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Status of Intune Pivot device query. + +## Members +|Member|Value|Description| +|:---|:---|:---| +|created|0|Created| +|notified|1|Notified| +|pending|2|Pending| +|timedOut|3|TimedOut| +|internalServiceError|4|InternalServiceError| +|successful|5|Successful| +|failed|6|Failed| +|unknownFutureValue|7|UnknownFutureValue| diff --git a/api-reference/beta/resources/intune-rbac-operationapprovalpolicyplatform.md b/api-reference/beta/resources/intune-rbac-operationapprovalpolicyplatform.md new file mode 100644 index 00000000000..dc2938e215f --- /dev/null +++ b/api-reference/beta/resources/intune-rbac-operationapprovalpolicyplatform.md @@ -0,0 +1,31 @@ +--- +title: "operationApprovalPolicyPlatform enum type" +description: "The set of available platforms for the OperationApprovalPolicy. Allows configuration of a policy to specific platform(s) for approval. If no specific platform is required or applicable, the platform is `notApplicable`." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: enumPageType +--- + +# operationApprovalPolicyPlatform enum type + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +The set of available platforms for the OperationApprovalPolicy. Allows configuration of a policy to specific platform(s) for approval. If no specific platform is required or applicable, the platform is `notApplicable`. + +## Members +|Member|Value|Description| +|:---|:---|:---| +|notApplicable|0|Default. Indicates that a policy platform is not required for a chosen policy type.| +|androidDeviceAdministrator|1|Indicates that the configured policy platform is for Android Device Administrator.| +|androidEnterprise|2|Indicates that the configured policy platform is for Android Enterprise.| +|iOSiPadOS|4|Indicates that the configured policy platform is for iOS/iPadOS.| +|macOS|8|Indicates that the configured policy platform is for macOS.| +|windows10AndLater|16|Indicates that the configured policy platform is for Windows 10 and later.| +|windows81AndLater|32|Indicates that the configured policy platform is for Windows 8.1 and later.| +|windows10X|64|Indicates that the configured policy platform is for Windows 10X.| +|unknownFutureValue|128|Evolvable enumeration sentinel value. Do not use.| diff --git a/api-reference/beta/resources/intune-rbac-operationapprovalpolicytype.md b/api-reference/beta/resources/intune-rbac-operationapprovalpolicytype.md new file mode 100644 index 00000000000..49343a0ce1d --- /dev/null +++ b/api-reference/beta/resources/intune-rbac-operationapprovalpolicytype.md @@ -0,0 +1,43 @@ +--- +title: "operationApprovalPolicyType enum type" +description: "The set of available policy types that can be configured for approval. There is no default value for this enum, indicating that the policy type must always be chosen." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: enumPageType +--- + +# operationApprovalPolicyType enum type + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +The set of available policy types that can be configured for approval. There is no default value for this enum, indicating that the policy type must always be chosen. + +## Members +|Member|Value|Description| +|:---|:---|:---| +|deviceAction|1|Indicates that the configured policy type is for a Device Action.| +|deviceWipe|2|Indicates that the configured policy type is for a Device Wipe Action.| +|deviceRetire|3|Indicates that the configured policy type is for a Device Retire Action.| +|deviceRetireNonCompliant|4|Indicates that the configured policy type is for a Retire Non-Compliant Devices Action.| +|deviceDelete|5|Indicates that the configured policy type is for a Device Delete Action.| +|deviceLock|6|Indicates that the configured policy type is for a Device Lock Action.| +|deviceErase|7|Indicates that the configured policy type is for a Device Erase Action.| +|deviceDisableActivationLock|8|Indicates that the configured policy type is for a Device Disable Activation Lock Action.| +|windowsEnrollment|9|Indicates that the configured policy type is for a Windows Enrollment.| +|compliancePolicy|10|Indicates that the configured policy type is for a Compliance Policy.| +|configurationPolicy|11|Indicates that the configured policy type is for a Configuration Policy.| +|appProtectionPolicy|12|Indicates that the configured policy type is for an App Protection Policy.| +|policySet|13|Indicates that the configured policy type is for a Policy Set.| +|filter|14|Indicates that the configured policy type is for a Filter.| +|endpointSecurityPolicy|15|Indicates that the configured policy type is for an Endpoint Security Policy.| +|app|16|Indicates that the configured policy type is an application type, such as mobile apps or built-in apps.| +|scripts|17|Indicates that the configured policy type is a script type, such as Powershell scripts or remediation scripts.| +|role|18|Indicates that the configured policy type is for a Role.| +|deviceResetPasscode|19|Indicates that the configured policy type is for a Device Reset Passcode Action.| +|customOrganizationalMessage|20|Indicates that the configured policy type is for a Custom Organizational Message.| +|unknownFutureValue|21|Evolvable enumeration sentinel value. Do not use.| diff --git a/api-reference/beta/resources/intune-rbac-operationapprovalrequestentitystatus.md b/api-reference/beta/resources/intune-rbac-operationapprovalrequestentitystatus.md new file mode 100644 index 00000000000..70460beca85 --- /dev/null +++ b/api-reference/beta/resources/intune-rbac-operationapprovalrequestentitystatus.md @@ -0,0 +1,46 @@ +--- +title: "operationApprovalRequestEntityStatus resource type" +description: "The operationApprovalRequestEntityStatus complex type is used to provide the basic infortmation relating to the status of a request without revealing too much information to the calling user as it may be an object out of scope." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: resourcePageType +--- + +# operationApprovalRequestEntityStatus resource type + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +The operationApprovalRequestEntityStatus complex type is used to provide the basic infortmation relating to the status of a request without revealing too much information to the calling user as it may be an object out of scope. + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|requestId|String|The unique identifier of the OperationApprovalRequest. This property cannot be modified and is required when the entity status is created. Read-only. This property is read-only.| +|requestExpirationDateTime|DateTimeOffset|Indicates the DateTime when any action on the OperationApprovalRequest is no longer permitted. The value cannot be modified and is automatically populated when the request is created using expiration offset values defined in the service controllers. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 would look like this: '2014-01-01T00:00:00Z'. Returned by default. Read-only. This property is read-only.| +|requestStatus|[operationApprovalRequestStatus](../resources/intune-rbac-operationapprovalrequeststatus.md)|The current approval status of the OperationApprovalRequest. Possible values are: `unknown`, `needsApproval`, `approved`, `rejected`, `cancelled`, `completed`, `expired`. Default value is `unknown`. Read-only. This property is read-only. Possible values are: `unknown`, `needsApproval`, `approved`, `rejected`, `cancelled`, `completed`, `expired`, `unknownFutureValue`.| +|entityLocked|Boolean|The status of the Entity connected to the OperationApprovalRequest in regard to changes, whether further requests are allowed or if the Entity is locked. When `true`, a lock is present on the Entity and no approval requests can be currently made for it. When `false`, the Entity is not locked and approval requests are allowed. Default value is `false`. Read-only. This property is read-only.| + +## Relationships +None + +## JSON Representation +Here is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.operationApprovalRequestEntityStatus", + "requestId": "String", + "requestExpirationDateTime": "String (timestamp)", + "requestStatus": "String", + "entityLocked": true +} +``` diff --git a/api-reference/beta/resources/intune-rbac-operationapprovalrequeststatus.md b/api-reference/beta/resources/intune-rbac-operationapprovalrequeststatus.md new file mode 100644 index 00000000000..643746f1cb3 --- /dev/null +++ b/api-reference/beta/resources/intune-rbac-operationapprovalrequeststatus.md @@ -0,0 +1,30 @@ +--- +title: "operationApprovalRequestStatus enum type" +description: "Indicates the status of the Approval Request. The status of a request will change when an action is successfully performed on it, such as when it is `approved` or `rejected`, or when the request's expiration DateTime passes and the result is `expired`." +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: enumPageType +--- + +# operationApprovalRequestStatus enum type + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Indicates the status of the Approval Request. The status of a request will change when an action is successfully performed on it, such as when it is `approved` or `rejected`, or when the request's expiration DateTime passes and the result is `expired`. + +## Members +|Member|Value|Description| +|:---|:---|:---| +|unknown|0|Default. Indicates that the request approval status is unknown, and that the status has not been assigned to the approval request.| +|needsApproval|1|Indicates that the approval request needs approval before the operation can be completed.| +|approved|2|Indicates that the approval request has been approved. The operation can now be completed.| +|rejected|3|Indicates that the approval request has been rejected. No further action can be taken to complete the operation or to modify the request.| +|cancelled|4|Indicates that the approval request has been cancelled by the request's requestor. No further action can be taken to complete the operation or to modify the request.| +|completed|5|Indicates that the approval request has been completed. This status is feature agnostic and does not indicate success or failure of the operation. No further action is necessary for the operation or to modify the request.| +|expired|6|Indicates that the approval request has expired. No further action can be taken to complete the operation or to modify the request. A new approval request must be made and approved in order to complete the operation.| +|unknownFutureValue|7|Evolvable enumeration sentinel value. Do not use.| diff --git a/api-reference/beta/resources/intune-remoteassistance-allowedremoteassistanceactions.md b/api-reference/beta/resources/intune-remoteassistance-allowedremoteassistanceactions.md new file mode 100644 index 00000000000..d17f50fdf4a --- /dev/null +++ b/api-reference/beta/resources/intune-remoteassistance-allowedremoteassistanceactions.md @@ -0,0 +1,27 @@ +--- +title: "allowedRemoteAssistanceActions enum type" +description: "Flags enumeration indicating whether a helper can establish a "View screen", "Take full control", "Elevation" and "Unattended" remote assistance action with a device or sharer" +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: enumPageType +--- + +# allowedRemoteAssistanceActions enum type + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Flags enumeration indicating whether a helper can establish a "View screen", "Take full control", "Elevation" and "Unattended" remote assistance action with a device or sharer + +## Members +|Member|Value|Description| +|:---|:---|:---| +|viewScreen|1|Helper can view the screen of the sharer's device| +|takeFullControl|2|Helper can take full control of the sharer's device| +|elevation|4|Helper can take full control of the sharer's device with elevated privileges| +|unattended|8|Helper can take unattended control on sharer's device| +|unknownFutureValue|16|unknownFutureValue - For making the Enum evolvable| diff --git a/api-reference/beta/resources/intune-remoteassistance-createremotehelpsessionresponse.md b/api-reference/beta/resources/intune-remoteassistance-createremotehelpsessionresponse.md new file mode 100644 index 00000000000..66d4a736e53 --- /dev/null +++ b/api-reference/beta/resources/intune-remoteassistance-createremotehelpsessionresponse.md @@ -0,0 +1,42 @@ +--- +title: "createRemoteHelpSessionResponse resource type" +description: "Remote help - response we provide back to the helper after successfully creating an ACS session" +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: resourcePageType +--- + +# createRemoteHelpSessionResponse resource type + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Remote help - response we provide back to the helper after successfully creating an ACS session + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|sessionKey|String|The unique identifier for a session| +|sessionType|[allowedRemoteAssistanceActions](../resources/intune-remoteassistance-allowedremoteassistanceactions.md)|Remote Help Session Type. Possible values are: `viewScreen`, `takeFullControl`, `elevation`, `unattended`, `unknownFutureValue`.| + +## Relationships +None + +## JSON Representation +Here is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.createRemoteHelpSessionResponse", + "sessionKey": "String", + "sessionType": "String" +} +``` diff --git a/api-reference/beta/resources/intune-remoteassistance-extendremotehelpsessionresponse.md b/api-reference/beta/resources/intune-remoteassistance-extendremotehelpsessionresponse.md new file mode 100644 index 00000000000..4b226a4ceba --- /dev/null +++ b/api-reference/beta/resources/intune-remoteassistance-extendremotehelpsessionresponse.md @@ -0,0 +1,46 @@ +--- +title: "extendRemoteHelpSessionResponse resource type" +description: "Remote help - response we provide back to the helper after getting response from pubSub" +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: resourcePageType +--- + +# extendRemoteHelpSessionResponse resource type + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Remote help - response we provide back to the helper after getting response from pubSub + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|sessionKey|String|The unique identifier for a session| +|acsHelperUserToken|String|Helper ACS User Token| +|pubSubHelperAccessUri|String|Azure Pubsub Group Id| +|sessionExpirationDateTime|DateTimeOffset|Azure Pubsub Session Expiration Date Time.| + +## Relationships +None + +## JSON Representation +Here is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.extendRemoteHelpSessionResponse", + "sessionKey": "String", + "acsHelperUserToken": "String", + "pubSubHelperAccessUri": "String", + "sessionExpirationDateTime": "String (timestamp)" +} +``` diff --git a/api-reference/beta/resources/intune-remoteassistance-remoteassistancereporting.md b/api-reference/beta/resources/intune-remoteassistance-remoteassistancereporting.md new file mode 100644 index 00000000000..eb2dd810f74 --- /dev/null +++ b/api-reference/beta/resources/intune-remoteassistance-remoteassistancereporting.md @@ -0,0 +1,84 @@ +--- +title: "remoteAssistanceReporting resource type" +description: "RemoteAssistanceReporting resources represents the metadata of a given Remote Assistance reporting payload" +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: resourcePageType +--- + +# remoteAssistanceReporting resource type + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +RemoteAssistanceReporting resources represents the metadata of a given Remote Assistance reporting payload + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|id|String|The unique identifier for a session and for each sessions's reporting payload| +|startDateTime|DateTimeOffset|Start time for the session| +|endDateTime|DateTimeOffset|End time for the session| +|remoteAssistanceSessionType|[remoteAssistanceSessionType](../resources/intune-remoteassistance-remoteassistancesessiontype.md)|Type of the remote assistance session that was held. Possible values are: `viewOnly`, `fullControl`, `elevation`. Possible values are: `viewOnly`, `fullControl`, `elevation`, `unattended`.| +|helperEmail|String|Login email used by the helper to establish the session| +|helperTenantId|String|Tenant id for the helper| +|helperUserId|String|Helper's id| +|helperFirstName|String|Helper's first name| +|helperLastName|String|Helper's last name| +|helperOs|String|Helper's operating system| +|deviceId|String|Intune Device ID| +|helperDeviceAadId|String|Helper's device AAD Id| +|helperDeviceName|String|Helper's device name| +|helperEnrollmentState|[enrollmentState](../resources/intune-shared-enrollmentstate.md)|Intune enrollment state of the helper's device. Possible values are: `unknown`, `enrolled`, `pendingReset`, `failed`, `notContacted`, `blocked`. Possible values are: `unknown`, `enrolled`, `pendingReset`, `failed`, `notContacted`, `blocked`.| +|sharerEmail|String|Login email used by the sharer to establish the session| +|sharerTenantId|String|Tenant id for the sharer| +|sharerFirstName|String|Sharer's first name| +|sharerLastName|String|Sharer's last name| +|sharerDeviceAadId|String|Sharer's device AAD Id| +|sharerDeviceName|String|Sharer's device name| +|sharerOs|String|Sharer's operating system| +|sharerEnrollmentState|[enrollmentState](../resources/intune-shared-enrollmentstate.md)|Intune enrollment state of the sharer's device. Possible values are: `unknown`, `enrolled`, `pendingReset`, `failed`, `notContacted`, `blocked`. Possible values are: `unknown`, `enrolled`, `pendingReset`, `failed`, `notContacted`, `blocked`.| +|sharerDeviceSerialNumber|String|Sharer device serial number| + +## Relationships +None + +## JSON Representation +Here is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.remoteAssistanceReporting", + "id": "String (identifier)", + "startDateTime": "String (timestamp)", + "endDateTime": "String (timestamp)", + "remoteAssistanceSessionType": "String", + "helperEmail": "String", + "helperTenantId": "String", + "helperUserId": "String", + "helperFirstName": "String", + "helperLastName": "String", + "helperOs": "String", + "deviceId": "String", + "helperDeviceAadId": "String", + "helperDeviceName": "String", + "helperEnrollmentState": "String", + "sharerEmail": "String", + "sharerTenantId": "String", + "sharerFirstName": "String", + "sharerLastName": "String", + "sharerDeviceAadId": "String", + "sharerDeviceName": "String", + "sharerOs": "String", + "sharerEnrollmentState": "String", + "sharerDeviceSerialNumber": "String" +} +``` diff --git a/api-reference/beta/resources/intune-remoteassistance-remoteassistancesessiontype.md b/api-reference/beta/resources/intune-remoteassistance-remoteassistancesessiontype.md new file mode 100644 index 00000000000..55cc8f8414c --- /dev/null +++ b/api-reference/beta/resources/intune-remoteassistance-remoteassistancesessiontype.md @@ -0,0 +1,26 @@ +--- +title: "remoteAssistanceSessionType enum type" +description: "Type of the remote assist session that was held. Possible values are: `viewOnly`, `fullControl`, `elevation`, `unattended`" +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: enumPageType +--- + +# remoteAssistanceSessionType enum type + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Type of the remote assist session that was held. Possible values are: `viewOnly`, `fullControl`, `elevation`, `unattended` + +## Members +|Member|Value|Description| +|:---|:---|:---| +|viewOnly|0|This status denotes a view only session between helper and sharer.| +|fullControl|1|This status denotes a session where helper was able to take full control of the sharer's device.| +|elevation|2|This status denotes a session where helper was able to take administrative actions on the sharer's device.| +|unattended|3|This status denotes a session where helper was able to take actions in a device, without sharer user.| diff --git a/api-reference/beta/resources/intune-remoteassistance-requestremotehelpsessionaccessresponse.md b/api-reference/beta/resources/intune-remoteassistance-requestremotehelpsessionaccessresponse.md new file mode 100644 index 00000000000..f746b101e01 --- /dev/null +++ b/api-reference/beta/resources/intune-remoteassistance-requestremotehelpsessionaccessresponse.md @@ -0,0 +1,46 @@ +--- +title: "requestRemoteHelpSessionAccessResponse resource type" +description: "Remote help - response we provide back to the helper after getting response from pubSub" +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: resourcePageType +--- + +# requestRemoteHelpSessionAccessResponse resource type + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Remote help - response we provide back to the helper after getting response from pubSub + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|sessionKey|String|The unique identifier for a session| +|sessionType|[allowedRemoteAssistanceActions](../resources/intune-remoteassistance-allowedremoteassistanceactions.md)|Remote Help Session Type. Possible values are: `viewScreen`, `takeFullControl`, `elevation`, `unattended`, `unknownFutureValue`.| +|pubSubEncryptionKey|String|The unique identifier for encrypting client messages sent to PubSub| +|pubSubEncryption|String|AES encryption Initialization Vector for encrypting client messages sent to PubSub| + +## Relationships +None + +## JSON Representation +Here is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.requestRemoteHelpSessionAccessResponse", + "sessionKey": "String", + "sessionType": "String", + "pubSubEncryptionKey": "String", + "pubSubEncryption": "String" +} +``` diff --git a/api-reference/beta/resources/intune-remoteassistance-retrieveremotehelpsessionresponse.md b/api-reference/beta/resources/intune-remoteassistance-retrieveremotehelpsessionresponse.md new file mode 100644 index 00000000000..1d25cfaf318 --- /dev/null +++ b/api-reference/beta/resources/intune-remoteassistance-retrieveremotehelpsessionresponse.md @@ -0,0 +1,58 @@ +--- +title: "retrieveRemoteHelpSessionResponse resource type" +description: "Remote help - response we provide back to the helper on retrieve session API call" +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: resourcePageType +--- + +# retrieveRemoteHelpSessionResponse resource type + +Namespace: microsoft.graph + +> **Important:** Microsoft Graph APIs under the /beta version are subject to change; production use is not supported. + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Remote help - response we provide back to the helper on retrieve session API call + +## Properties +|Property|Type|Description| +|:---|:---|:---| +|sessionKey|String|The unique identifier for a session| +|acsHelperUserToken|String|Helper ACS User Token| +|acsHelperUserId|String|Helper ACS User Id| +|acsSharerUserId|String|Sharer ACS User Id| +|acsGroupId|String|ACS Group Id| +|sessionType|[allowedRemoteAssistanceActions](../resources/intune-remoteassistance-allowedremoteassistanceactions.md)|Remote Help Session Type. Possible values are: `viewScreen`, `takeFullControl`, `elevation`, `unattended`, `unknownFutureValue`.| +|deviceName|String|Android Device Name| +|pubSubGroupId|String|Azure Pubsub Group Id| +|pubSubHelperAccessUri|String|Azure Pubsub Group Id| +|sessionExpirationDateTime|DateTimeOffset|Azure Pubsub Session Expiration Date Time.| + +## Relationships +None + +## JSON Representation +Here is a JSON representation of the resource. + +``` json +{ + "@odata.type": "#microsoft.graph.retrieveRemoteHelpSessionResponse", + "sessionKey": "String", + "acsHelperUserToken": "String", + "acsHelperUserId": "String", + "acsSharerUserId": "String", + "acsGroupId": "String", + "sessionType": "String", + "deviceName": "String", + "pubSubGroupId": "String", + "pubSubHelperAccessUri": "String", + "sessionExpirationDateTime": "String (timestamp)" +} +``` diff --git a/api-reference/v1.0/api/intune-reporting-devicemanagementreports-getautopilotdeploymentstatus.md b/api-reference/v1.0/api/intune-reporting-devicemanagementreports-getautopilotdeploymentstatus.md new file mode 100644 index 00000000000..5cf45021e21 --- /dev/null +++ b/api-reference/v1.0/api/intune-reporting-devicemanagementreports-getautopilotdeploymentstatus.md @@ -0,0 +1,103 @@ +--- +title: "getAutopilotDeploymentStatus action" +description: "Not yet documented" +author: "jaiprakashmb" +localization_priority: Normal +ms.prod: "intune" +doc_type: apiPageType +--- + +# getAutopilotDeploymentStatus action + +Namespace: microsoft.graph + +> **Note:** The Microsoft Graph API for Intune requires an [active Intune license](https://go.microsoft.com/fwlink/?linkid=839381) for the tenant. + +Not yet documented + +## Permissions +One of the following permissions is required to call this API. To learn more, including how to choose permissions, see [Permissions](/graph/permissions-reference). + +|Permission type|Permissions (from least to most privileged)| +|:---|:---| +|Delegated (work or school account)|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| +|Delegated (personal Microsoft account)|Not supported.| +|Application|DeviceManagementConfiguration.Read.All, DeviceManagementConfiguration.ReadWrite.All, DeviceManagementApps.Read.All, DeviceManagementApps.ReadWrite.All, DeviceManagementManagedDevices.Read.All, DeviceManagementManagedDevices.ReadWrite.All| + +## HTTP Request + +``` http +POST /deviceManagement/reports/getAutopilotDeploymentStatus +``` + +## Request headers +|Header|Value| +|:---|:---| +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| +|Accept|application/json| + +## Request body +In the request body, supply JSON representation of the parameters. + +The following table shows the parameters that can be used with this action. + +|Property|Type|Description| +|:---|:---|:---| +|name|String|Not yet documented| +|select|String collection|Not yet documented| +|search|String|Not yet documented| +|groupBy|String collection|Not yet documented| +|orderBy|String collection|Not yet documented| +|skip|Int32|Not yet documented| +|top|Int32|Not yet documented| +|sessionId|String|Not yet documented| +|filter|String|Not yet documented| + + + +## Response +If successful, this action returns a `200 OK` response code and a Stream in the response body. + +## Example + +### Request +Here is an example of the request. +``` http +POST https://graph.microsoft.com/v1.0/deviceManagement/reports/getAutopilotDeploymentStatus + +Content-type: application/json +Content-length: 278 + +{ + "name": "Name value", + "select": [ + "Select value" + ], + "search": "Search value", + "groupBy": [ + "Group By value" + ], + "orderBy": [ + "Order By value" + ], + "skip": 4, + "top": 3, + "sessionId": "Session Id value", + "filter": "Filter value" +} +``` + +### Response +Here is an example of the response. Note: The response object shown here may be truncated for brevity. All of the properties will be returned from an actual call. +``` http +HTTP/1.1 200 OK +Content-Type: application/json +Content-Length: 99 + +{ + "value": "Z2V0QXV0b3BpbG90RGVwbG95bWVudFN0YXR1cyBJbnR1bmUgRG9jIFNhbXBsZSAtMTQwMDQ1MDU5Mg==" +} +```