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

API Evangelist conversational phrasing for Identity.DirectoryManagement Users.scoped Role Membership…

7 actions 7 updates phrasing extends openapi/azure-ad-users-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['/users/{user-id}/scopedRoleMemberOf'].get
$.paths['/users/{user-id}/scopedRoleMemberOf'].post
$.paths['/users/{user-id}/scopedRoleMemberOf/{scopedRoleMembership-id}'].get
$.paths['/users/{user-id}/scopedRoleMemberOf/{scopedRoleMembership-id}'].delete
$.paths['/users/{user-id}/scopedRoleMemberOf/{scopedRoleMembership-id}'].patch
$.paths['/users/{user-id}/scopedRoleMemberOf/$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 Users.scoped Role Membership…
  version: 1.0.0
extends: openapi/azure-ad-users-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['/users/{user-id}/scopedRoleMemberOf'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's admin-unit scoped role assignments
      effect: read
      questions:
      - Which administrative units does a user hold an admin role in?
      - Can I filter a user's scoped role memberships by role?
      instructions:
      - text: List scoped role memberships for user {user_id}.
        slots:
          user_id: path.user-id
      - text: Show scoped roles of {user_id} matching {filter}.
        slots:
          user_id: path.user-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/scopedRoleMemberOf'].post
  update:
    x-apievangelist-phrasing:
      intent: Give a user a role scoped to an admin unit
      effect: write
      questions:
      - How do I make someone a helpdesk admin for just one administrative unit?
      - Can I assign a directory role to a user limited to a single admin unit?
      instructions:
      - text: Assign role {role_id} to user {user_id} scoped to administrative unit {unit_id}.
        slots:
          user_id: path.user-id
          role_id: requestBody.roleId
          unit_id: requestBody.administrativeUnitId
      - text: Add a scoped role membership for {user_id} in admin unit {unit_id}.
        slots:
          user_id: path.user-id
          unit_id: requestBody.administrativeUnitId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/scopedRoleMemberOf/{scopedRoleMembership-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one scoped role membership of a user
      effect: read
      questions:
      - What role and administrative unit does a specific scoped membership grant?
      - Can I read one of a user's scoped role memberships by ID?
      instructions:
      - text: Show scoped role membership {membership_id} for user {user_id}.
        slots:
          user_id: path.user-id
          membership_id: path.scopedRoleMembership-id
      - text: Get the role and admin unit on membership {membership_id} of {user_id}.
        slots:
          user_id: path.user-id
          membership_id: path.scopedRoleMembership-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/scopedRoleMemberOf/{scopedRoleMembership-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user's admin-unit scoped role
      effect: destructive
      questions:
      - How do I revoke a user's admin role over one administrative unit?
      - Can I delete a scoped role membership with an etag check?
      instructions:
      - text: Remove scoped role membership {membership_id} from user {user_id}.
        slots:
          user_id: path.user-id
          membership_id: path.scopedRoleMembership-id
      - text: Delete membership {membership_id} of {user_id} if the etag is {etag}.
        slots:
          user_id: path.user-id
          membership_id: path.scopedRoleMembership-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/scopedRoleMemberOf/{scopedRoleMembership-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a user's scoped role membership
      effect: write
      questions:
      - How do I move a user's scoped admin role to a different administrative unit?
      - Can I change the role on an existing scoped membership?
      instructions:
      - text: Change membership {membership_id} of user {user_id} to admin unit {unit_id}.
        slots:
          user_id: path.user-id
          membership_id: path.scopedRoleMembership-id
          unit_id: requestBody.administrativeUnitId
      - text: Set the role on scoped membership {membership_id} for {user_id} to {role_id}.
        slots:
          user_id: path.user-id
          membership_id: path.scopedRoleMembership-id
          role_id: requestBody.roleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/scopedRoleMemberOf/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a user's scoped role memberships
      effect: read
      questions:
      - How many admin-unit scoped roles does a user hold?
      - What number of a user's scoped memberships match a filter?
      instructions:
      - text: Count scoped role memberships for user {user_id}.
        slots:
          user_id: path.user-id
      - text: Count scoped roles of {user_id} matching {filter}.
        slots:
          user_id: path.user-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'