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

API Evangelist conversational phrasing for Identity.DirectoryManagement Directory Roles.scoped Role…

7 actions 7 updates phrasing extends openapi/azure-ad-directoryroles-scopedrolemembership-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 7

$.info
$.paths['/directoryRoles/{directoryRole-id}/scopedMembers'].get
$.paths['/directoryRoles/{directoryRole-id}/scopedMembers'].post
$.paths['/directoryRoles/{directoryRole-id}/scopedMembers/{scopedRoleMembership-id}'].get
$.paths['/directoryRoles/{directoryRole-id}/scopedMembers/{scopedRoleMembership-id}'].delete
$.paths['/directoryRoles/{directoryRole-id}/scopedMembers/{scopedRoleMembership-id}'].patch
$.paths['/directoryRoles/{directoryRole-id}/scopedMembers/$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.DirectoryManagement Directory Roles.scoped Role…
  version: 1.0.0
extends: openapi/azure-ad-directoryroles-scopedrolemembership-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: 6
- target: $.paths['/directoryRoles/{directoryRole-id}/scopedMembers'].get
  update:
    x-apievangelist-phrasing:
      intent: List scoped members of a directory role
      effect: read
      questions:
      - Who holds a directory role only within an administrative unit?
      - Which scoped role memberships exist for a given directory role?
      instructions:
      - text: List the scoped members of directory role {role}.
        slots:
          role: path.directoryRole-id
      - text: Show scoped memberships of role {role} matching {filter}.
        slots:
          role: path.directoryRole-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directoryRoles/{directoryRole-id}/scopedMembers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a scoped member to a directory role
      effect: write
      questions:
      - How do I grant someone a directory role scoped to one administrative unit?
      - Can I limit a role assignment to a single administrative unit?
      instructions:
      - text: Add {member} to role {role} scoped to administrative unit {unit}.
        slots:
          member: requestBody.roleMemberInfo
          role: path.directoryRole-id
          unit: requestBody.administrativeUnitId
      - text: Create a scoped membership on role {role} for administrative unit {unit}.
        slots:
          role: path.directoryRole-id
          unit: requestBody.administrativeUnitId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directoryRoles/{directoryRole-id}/scopedMembers/{scopedRoleMembership-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one scoped role membership
      effect: read
      questions:
      - Which administrative unit is a specific scoped role membership limited to?
      - What are the details of one scoped member of a directory role?
      instructions:
      - text: Get scoped membership {membership} of role {role}.
        slots:
          membership: path.scopedRoleMembership-id
          role: path.directoryRole-id
      - text: Show the administrative unit and member for scoped membership {membership} on role {role}.
        slots:
          membership: path.scopedRoleMembership-id
          role: path.directoryRole-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directoryRoles/{directoryRole-id}/scopedMembers/{scopedRoleMembership-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a scoped role membership
      effect: destructive
      questions:
      - How do I revoke someone's directory role within an administrative unit?
      - Can I delete a scoped role membership?
      instructions:
      - text: Remove scoped membership {membership} from role {role}.
        slots:
          membership: path.scopedRoleMembership-id
          role: path.directoryRole-id
      - text: Revoke the administrative-unit-scoped assignment {membership} on role {role}.
        slots:
          membership: path.scopedRoleMembership-id
          role: path.directoryRole-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directoryRoles/{directoryRole-id}/scopedMembers/{scopedRoleMembership-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a scoped role membership
      effect: write
      questions:
      - How do I move an existing scoped role membership to a different administrative unit?
      - Can I change the member on an existing scoped role membership?
      instructions:
      - text: Change scoped membership {membership} on role {role} to administrative unit {unit}.
        slots:
          membership: path.scopedRoleMembership-id
          role: path.directoryRole-id
          unit: requestBody.administrativeUnitId
      - text: Update member info of scoped membership {membership} on role {role} to {member}.
        slots:
          membership: path.scopedRoleMembership-id
          role: path.directoryRole-id
          member: requestBody.roleMemberInfo
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directoryRoles/{directoryRole-id}/scopedMembers/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count scoped members of a directory role
      effect: read
      questions:
      - How many administrative-unit-scoped members does a directory role have?
      - What is the number of scoped role memberships for one role?
      instructions:
      - text: Count the scoped members of directory role {role}.
        slots:
          role: path.directoryRole-id
      - text: Give me the number of scoped memberships on role {role} matching {filter}.
        slots:
          role: path.directoryRole-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'