Microsoft Entra ID (formerly Azure AD) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity.SignIns Information Protection.bitlocker API

5 actions 5 updates phrasing extends openapi/azure-ad-informationprotection-bitlocker-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Microsoft Entra ID (formerly Azure AD)'s API. It is a proposal applied on top of the contract, not a document Microsoft Entra ID (formerly Azure AD) publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/informationProtection/bitlocker'].get
$.paths['/informationProtection/bitlocker/recoveryKeys'].get
$.paths['/informationProtection/bitlocker/recoveryKeys/{bitlockerRecoveryKey-id}'].get
$.paths['/informationProtection/bitlocker/recoveryKeys/$count'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Identity.SignIns Information Protection.bitlocker API
  version: 1.0.0
extends: openapi/azure-ad-informationprotection-bitlocker-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/informationProtection/bitlocker'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the BitLocker information protection root
      effect: read
      questions:
      - Where does Microsoft Graph expose BitLocker data under information protection?
      - Can I read the bitlocker resource that holds recovery keys?
      instructions:
      - text: Get the BitLocker resource under information protection.
      - text: Show the bitlocker root object for my tenant.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/informationProtection/bitlocker/recoveryKeys'].get
  update:
    x-apievangelist-phrasing:
      intent: List BitLocker recovery keys
      effect: read
      questions:
      - Which BitLocker recovery keys are stored in my tenant, and for which devices?
      - Does listing BitLocker recovery keys return the actual key values?
      instructions:
      - text: List all BitLocker recovery key objects in the tenant.
      - text: Show BitLocker recovery key entries with their device ids, without the key values.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/informationProtection/bitlocker/recoveryKeys/{bitlockerRecoveryKey-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a BitLocker recovery key
      effect: read
      questions:
      - How do I retrieve the BitLocker recovery key for a locked-out drive?
      - Can I get the actual key value of one recovery key, not just its metadata?
      instructions:
      - text: Get BitLocker recovery key {key_id}.
        slots:
          key_id: path.bitlockerRecoveryKey-id
      - text: Retrieve recovery key {key_id} including its key property.
        slots:
          key_id: path.bitlockerRecoveryKey-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/informationProtection/bitlocker/recoveryKeys/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count BitLocker recovery keys
      effect: read
      questions:
      - How many BitLocker recovery keys are escrowed in my directory?
      - Can I get just a total of stored recovery keys?
      instructions:
      - text: Count the BitLocker recovery keys in the tenant.
      - text: Return only the number of escrowed recovery keys.
      method: generated
      generated: '2026-10-01'