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

API Evangelist conversational phrasing for Identity.DirectoryManagement Devices.device.Actions API

9 actions 9 updates phrasing extends openapi/azure-ad-devices-device-actions-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 9

$.info
$.paths['/devices/{device-id}/microsoft.graph.checkMemberGroups'].post
$.paths['/devices/{device-id}/microsoft.graph.checkMemberObjects'].post
$.paths['/devices/{device-id}/microsoft.graph.getMemberGroups'].post
$.paths['/devices/{device-id}/microsoft.graph.getMemberObjects'].post
$.paths['/devices/{device-id}/microsoft.graph.restore'].post
$.paths['/devices/microsoft.graph.getAvailableExtensionProperties'].post
$.paths['/devices/microsoft.graph.getByIds'].post
$.paths['/devices/microsoft.graph.validateProperties'].post

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.DirectoryManagement Devices.device.Actions API
  version: 1.0.0
extends: openapi/azure-ad-devices-device-actions-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: 8
- target: $.paths['/devices/{device-id}/microsoft.graph.checkMemberGroups'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a device's membership in given groups
      effect: read
      questions:
      - How do I check whether a device is in any of a specific list of groups?
      - Which of these group IDs does a registered device belong to?
      instructions:
      - text: Check which of groups {groupIds} device {device} is a member of.
        slots:
          groupIds: requestBody.groupIds
          device: path.device-id
      - text: 'Tell me if device {device} is in any of these groups: {groupIds}.'
        slots:
          device: path.device-id
          groupIds: requestBody.groupIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices/{device-id}/microsoft.graph.checkMemberObjects'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a device's membership in given objects
      effect: read
      questions:
      - Can I test a device against a mixed list of groups and administrative units?
      - Which of a set of directory object IDs is a device a member of?
      instructions:
      - text: Check which of directory objects {ids} device {device} is a member of.
        slots:
          ids: requestBody.ids
          device: path.device-id
      - text: Verify device {device}'s membership against object IDs {ids}.
        slots:
          device: path.device-id
          ids: requestBody.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices/{device-id}/microsoft.graph.getMemberGroups'].post
  update:
    x-apievangelist-phrasing:
      intent: List all groups a device belongs to
      effect: read
      questions:
      - What groups is a particular device a member of, including transitively?
      - Can I return only security-enabled groups for a device?
      instructions:
      - text: Get every group ID device {device} belongs to.
        slots:
          device: path.device-id
      - text: List groups of device {device} with security-enabled-only set to {securityOnly}.
        slots:
          device: path.device-id
          securityOnly: requestBody.securityEnabledOnly
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices/{device-id}/microsoft.graph.getMemberObjects'].post
  update:
    x-apievangelist-phrasing:
      intent: List groups, roles and admin units of a device
      effect: read
      questions:
      - Which groups, administrative units and directory roles is a device part of?
      - Can I get all of a device's memberships rather than just its groups?
      instructions:
      - text: Get all group, role and administrative unit IDs for device {device}.
        slots:
          device: path.device-id
      - text: 'List every membership object of device {device}, security-enabled only: {securityOnly}.'
        slots:
          device: path.device-id
          securityOnly: requestBody.securityEnabledOnly
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices/{device-id}/microsoft.graph.restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a deleted device
      effect: write
      questions:
      - How do I bring back a device object that was recently deleted from Entra ID?
      - Can a deleted device be recovered from deleted items?
      instructions:
      - text: Restore deleted device {device}.
        slots:
          device: path.device-id
      - text: Recover device {device} from the directory's deleted items.
        slots:
          device: path.device-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices/microsoft.graph.getAvailableExtensionProperties'].post
  update:
    x-apievangelist-phrasing:
      intent: List extension properties usable on devices
      effect: read
      questions:
      - What directory extension properties are registered that I could set on devices?
      - Can I filter available extension properties to those synced from on-premises?
      instructions:
      - text: List directory extension definitions available from the devices collection.
      - text: Get extension properties for devices where synced-from-on-premises is {synced}.
        slots:
          synced: requestBody.isSyncedFromOnPremises
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices/microsoft.graph.getByIds'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up devices and objects by a list of IDs
      effect: read
      questions:
      - How can I fetch several devices at once from a list of their IDs?
      - Can an ID lookup from the devices collection be limited to the device type?
      instructions:
      - text: Get the devices for IDs {ids}.
        slots:
          ids: requestBody.ids
      - text: Resolve object IDs {ids} from devices limited to types {types}.
        slots:
          ids: requestBody.ids
          types: requestBody.types
      method: generated
      generated: '2026-10-01'
- target: $.paths['/devices/microsoft.graph.validateProperties'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate group naming from the devices collection
      effect: read
      questions:
      - Can I check a proposed group display name against naming policy via the devices endpoint?
      - Does a mail nickname comply with our tenant's group naming rules?
      instructions:
      - text: Validate display name {displayName} for naming policy compliance using the devices action.
        slots:
          displayName: requestBody.displayName
      - text: Check mail nickname {mailNickname} for a {entityType} on behalf of {userId} via devices.
        slots:
          mailNickname: requestBody.mailNickname
          entityType: requestBody.entityType
          userId: requestBody.onBehalfOfUserId
      method: generated
      generated: '2026-10-01'