Skip to content

Latest commit

 

History

History
231 lines (183 loc) · 9.33 KB

bitlockerrecoverykey-get.md

File metadata and controls

231 lines (183 loc) · 9.33 KB
Raw
title description author ms.localizationpriority ms.subservice doc_type
Get bitlockerRecoveryKey
Retrieve the properties and relationships of a bitlockerRecoveryKey object.
myra-ramdenbourg
medium
entra-directory-management
apiPageType

Get bitlockerRecoveryKey

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Retrieve the properties and relationships of a bitlockerRecoveryKey object.

By default, this operation does not return the key property that represents the actual recovery key. To include the key property in the response, use the $select OData query parameter. Including the $select query parameter triggers a Microsoft Entra audit of the operation and generates an audit log. You can find the log in Microsoft Entra audit logs under the KeyManagement category.

[!INCLUDE national-cloud-support]

Permissions

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

[!INCLUDE permissions-table]

Note: For delegated permissions to allow apps to get bitLockerRecoveryKey resources on behalf of the signed-in user, the tenant administrator must have assigned the user one of the following Microsoft Entra roles, or the user must be the registered owner of the device that the BitLocker key was originally backed up from:

  • Cloud Device Administrator
  • Helpdesk Administrator
  • Intune Service Administrator
  • Security Administrator
  • Security Reader
  • Global Reader

HTTP request

To get the specified BitLocker key without returning the key property:

GET /informationProtection/bitlocker/recoveryKeys/{bitlockeryRecoveryKeyId}

To get the specified BitLocker key including its key property:

GET /informationProtection/bitlocker/recoveryKeys/{bitlockeryRecoveryKeyId}?$select=key

Optional query parameters

This method supports the $select OData query parameter to return the key property. For details, see Example 2. For general information, see OData query parameters.

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 bitlockerRecoveryKey object in the response body.

Examples

Example 1: Get the BitLocker key by specifying the key id

Request

The following example shows a request. This example does not return the key property.

HTTP

GET https://graph.microsoft.com/beta/informationProtection/bitlocker/recoveryKeys/b465e4e8-e4e8-b465-e8e4-65b4e8e465b4
User-Agent: Dsreg/10.0 (Windows 10.0.19043.1466)
ocp-client-name: My Friendly Client
ocp-client-version: 1.2

C#

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

CLI

[!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

{
  "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"
  }
}

Example 2: Get the BitLocker key with the key property by specifying the key id

Request

The following example shows a request.

HTTP

GET https://graph.microsoft.com/beta/informationProtection/bitlocker/recoveryKeys/b465e4e8-e4e8-b465-e8e4-65b4e8e465b4?$select=key
User-Agent: Dsreg/10.0 (Windows 10.0.19043.1466)
ocp-client-name: My Friendly Client
ocp-client-version: 1.2

C#

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

CLI

[!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

{
  "value": {
    "@odata.type": "#microsoft.graph.bitlockerRecoveryKey",
    "id": "b465e4e8-e4e8-b465-e8e4-65b4e8e465b4",
    "createdDateTime": "String (timestamp)",
    "volumeType": 1,
    "deviceId": "1ab40ab2-32a8-4b00-b6b5-ba724e407de9",
    "key": "123456-231453-873456-213546-654678-765689-123456-324565"
  }
}