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

API Evangelist conversational phrasing for Identity.DirectoryManagement Directory Roles.directory…

9 actions 9 updates phrasing extends openapi/azure-ad-directoryroles-directoryrole-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['/directoryRoles/{directoryRole-id}/microsoft.graph.checkMemberGroups'].post
$.paths['/directoryRoles/{directoryRole-id}/microsoft.graph.checkMemberObjects'].post
$.paths['/directoryRoles/{directoryRole-id}/microsoft.graph.getMemberGroups'].post
$.paths['/directoryRoles/{directoryRole-id}/microsoft.graph.getMemberObjects'].post
$.paths['/directoryRoles/{directoryRole-id}/microsoft.graph.restore'].post
$.paths['/directoryRoles/microsoft.graph.getAvailableExtensionProperties'].post
$.paths['/directoryRoles/microsoft.graph.getByIds'].post
$.paths['/directoryRoles/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 Directory Roles.directory…
  version: 1.0.0
extends: openapi/azure-ad-directoryroles-directoryrole-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['/directoryRoles/{directoryRole-id}/microsoft.graph.checkMemberGroups'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a directory role's membership in given groups
      effect: read
      questions:
      - Which of a list of groups is this directory role a member of?
      - Can I check a directory role against specific group IDs rather than listing all its groups?
      instructions:
      - text: Check which of groups {group_ids} directory role {role} belongs to.
        slots:
          role: path.directoryRole-id
          group_ids: requestBody.groupIds
      - text: Test group membership of role {role} against {group_ids}.
        slots:
          role: path.directoryRole-id
          group_ids: requestBody.groupIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directoryRoles/{directoryRole-id}/microsoft.graph.checkMemberObjects'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a directory role's membership in given objects
      effect: read
      questions:
      - Is this directory role a member of any of these groups, administrative units or roles?
      - Can I check a role against a mixed list of object IDs, not just groups?
      instructions:
      - text: Check which of objects {ids} directory role {role} is a member of.
        slots:
          role: path.directoryRole-id
          ids: requestBody.ids
      - text: 'Test role {role} for membership in these directory objects: {ids}.'
        slots:
          role: path.directoryRole-id
          ids: requestBody.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directoryRoles/{directoryRole-id}/microsoft.graph.getMemberGroups'].post
  update:
    x-apievangelist-phrasing:
      intent: Get all groups a directory role belongs to
      effect: read
      questions:
      - What are all the group IDs a directory role is a member of?
      - Can I limit a directory role's group membership lookup to security-enabled groups?
      instructions:
      - text: Get every group ID that directory role {role} belongs to.
        slots:
          role: path.directoryRole-id
      - text: List only security-enabled group memberships of role {role} ({security_only}).
        slots:
          role: path.directoryRole-id
          security_only: requestBody.securityEnabledOnly
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directoryRoles/{directoryRole-id}/microsoft.graph.getMemberObjects'].post
  update:
    x-apievangelist-phrasing:
      intent: Get all groups, units and roles a directory role belongs to
      effect: read
      questions:
      - Which groups, administrative units and directory roles is a given directory role a member of?
      - Can I get a directory role's memberships across object types, not just groups?
      instructions:
      - text: Get all group, administrative unit and role IDs directory role {role} is a member of.
        slots:
          role: path.directoryRole-id
      - text: Return every membership object of role {role}, security-enabled only set to {security_only}.
        slots:
          role: path.directoryRole-id
          security_only: requestBody.securityEnabledOnly
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directoryRoles/{directoryRole-id}/microsoft.graph.restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a recently deleted directory object
      effect: write
      questions:
      - How do I bring back a directory object that was recently deleted?
      - Can I restore something from deleted items using this directory role path?
      instructions:
      - text: Restore deleted directory object {role}.
        slots:
          role: path.directoryRole-id
      - text: Recover {role} from the directory's deleted items.
        slots:
          role: path.directoryRole-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directoryRoles/microsoft.graph.getAvailableExtensionProperties'].post
  update:
    x-apievangelist-phrasing:
      intent: List registered directory extension properties
      effect: read
      questions:
      - Which directory extension definitions are registered in my tenant, including from multitenant apps?
      - Can I see only the extension properties synced from on-premises?
      instructions:
      - text: List all directory extension properties available in my tenant.
      - text: Show extension properties where synced-from-on-premises is {synced}.
        slots:
          synced: requestBody.isSyncedFromOnPremises
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directoryRoles/microsoft.graph.getByIds'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch directory objects by a list of IDs
      effect: read
      questions:
      - How do I resolve a batch of object IDs to the directory objects they belong to?
      - Can I restrict an ID lookup to certain object types like users or groups?
      instructions:
      - text: Get the directory objects for IDs {ids}.
        slots:
          ids: requestBody.ids
      - text: Resolve IDs {ids} limited to types {types}.
        slots:
          ids: requestBody.ids
          types: requestBody.types
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directoryRoles/microsoft.graph.validateProperties'].post
  update:
    x-apievangelist-phrasing:
      intent: Check a group name against naming policy
      effect: read
      questions:
      - Will a Microsoft 365 group display name comply with our naming policy before I create it?
      - Can I validate a mail nickname against blocked words on behalf of a user?
      instructions:
      - text: Validate group display name {display_name} with mail nickname {nickname}.
        slots:
          display_name: requestBody.displayName
          nickname: requestBody.mailNickname
      - text: Check {display_name} against naming policy on behalf of user {user}.
        slots:
          display_name: requestBody.displayName
          user: requestBody.onBehalfOfUserId
      method: generated
      generated: '2026-10-01'