List recoveryKeys

Namespace: microsoft.graph

Get a list of the bitlockerRecoveryKey objects and their properties.

This operation does not return the key property. For information about how to read the key property, see Get bitlockerRecoveryKey.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet

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.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) BitlockerKey.ReadBasic.All BitlockerKey.Read.All
Delegated (personal Microsoft account) Not supported. Not supported.
Application BitlockerKey.ReadBasic.All BitlockerKey.Read.All

For delegated permissions, the calling user must be the registered owner of the device that the BitLocker recovery key was originally backed up from, or they must be in at least one of the following Microsoft Entra roles:

  • Cloud device administrator
  • Helpdesk administrator
  • Intune service administrator
  • Security administrator
  • Security reader
  • Global reader

HTTP request

To get a list of BitLocker keys within the tenant:

GET /informationProtection/bitlocker/recoveryKeys

Optional query parameters

This method supports the $filter OData query parameter to filter results by the deviceId of the device that the key was most recently backed up to. This method does not support $top. For general information, see OData query parameters.

The response might also contain an odata.nextLink, which you can use to page through the result set. For details, see Paging Microsoft Graph data.

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
User-Agent The identifier for the calling application. This value contains information about the operating system and the browser used. Required.
ocp-client-name The name of the client application performing the API call. This header is used for debugging purposes. Optional.
ocp-client-version The version of the client application performing the API call. This header is used for debugging purposes. Optional.

Request body

Don't supply a request body for this method.

Response

If successful, this method returns a 200 OK response code and a collection of bitlockerRecoveryKey objects in the response body.

Examples

Example 1: Retrieve a list of BitLocker keys in the tenant.

Request

The following example shows a request.

GET https://graph.microsoft.com/v1.0/informationProtection/bitlocker/recoveryKeys
User-Agent: Dsreg/10.0 (Windows 10.0.19043.1466)
ocp-client-name: My Friendly Client
ocp-client-version: 1.2

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

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.bitlockerRecoveryKey",
      "id": "b465e4e8-e4e8-b465-e8e4-65b4e8e465b4",
      "createdDateTime": "2020-06-15T13:45:30.0000000Z",
      "volumeType": "1",
      "deviceId": "2ef04ef1-23b0-2e00-a3a5-ab345e567ab6"
    },
    {
      "@odata.type": "#microsoft.graph.bitlockerRecoveryKey",
      "id": "6a30ed7b-247b-4d26-86b5-2f405e55ea42",
      "createdDateTime": "2020-06-15T13:45:30.0000000Z",
      "volumeType": "1",
      "deviceId": "1ab40ab2-32a8-4b00-b6b5-ba724e407de9"
    }
  ]
}

Example 2: Retrieve a list of BitLocker keys filtered by deviceId

Request

The following example shows a request.

GET https://graph.microsoft.com/v1.0/informationProtection/bitlocker/recoveryKeys?$filter=deviceId eq '1ab40ab2-32a8-4b00-b6b5-ba724e407de9'
User-Agent: Dsreg/10.0 (Windows 10.0.19043.1466)
ocp-client-name: My Friendly Client
ocp-client-version: 1.2

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

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.bitlockerRecoveryKey",
      "id": "b465e4e8-e4e8-b465-e8e4-65b4e8e465b4",
      "createdDateTime": "2020-06-15T13:45:30.0000000Z",
      "volumeType": "1",
      "deviceId": "1ab40ab2-32a8-4b00-b6b5-ba724e407de9"
    }
  ]
}