Skip to content

longrunningoperation-get.md

Latest commit

 

History

History
146 lines (105 loc) · 5.29 KB

longrunningoperation-get.md

File metadata and controls

146 lines (105 loc) · 5.29 KB
title Get longRunningOperation
description Retrieve the status of a long-running Microsoft Graph API operation.
ms.localizationpriority medium
author jpettere
ms.reviewer intelligentaccesspm
ms.subservice entra-sign-in
doc_type apiPageType
ms.date 07/23/2024

Get longRunningOperation

Namespace: microsoft.graph

Read the properties and relationships of a longRunningOperation object. This API allows you to retrieve the details and status of the following long-running Microsoft Graph API operations.

The possible states of the long-running operation are notStarted, running, succeeded, failed, unknownFutureValue where succeeded and failed are terminal states.

[!INCLUDE national-cloud-support]

Permissions

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

For authentication methods (password reset)

[!INCLUDE permissions-table]

[!INCLUDE rbac-authentication-methods-apis-read-others]

HTTP request

To retrieve the status of a long running operation of authentication method reset:

GET /users/{id | userPrincipalName}/authentication/operations/{id}

Optional query parameters

This method supports the $select OData query parameter to help customize the response. For general information, see OData query parameters.

Request headers

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

Request body

Don't supply a request body for this method.

Response

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

Examples

Request

The following example shows a request. The ID of the operation to use in this request is retrieved from the response you get from the passwword reset operation.

HTTP

GET https://graph.microsoft.com/v1.0/users/{id | userPrincipalName}/authentication/operations/{id}

C#

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

Go

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

Java

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

JavaScript

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

PHP

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

PowerShell

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

Python

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

Response

The following example shows the response.

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

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

{
  "status": "running",
  "createdDateTime": "2020-03-19T12-01-03.45Z",
  "lastActionDateTime": "2020-03-19T12-01-04.23Z",
  "id": "2d497bb-57bd-47a6-8749-5ccd0869f2bd"
}