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

API Evangelist conversational phrasing for Applications Users.app Role Assignment API

7 actions 7 updates phrasing extends openapi/azure-ad-users-approleassignment-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}/appRoleAssignments'].get

$.paths['/users/{user-id}/appRoleAssignments'].post

$.paths['/users/{user-id}/appRoleAssignments/{appRoleAssignment-id}'].get

$.paths['/users/{user-id}/appRoleAssignments/{appRoleAssignment-id}'].delete

$.paths['/users/{user-id}/appRoleAssignments/{appRoleAssignment-id}'].patch

$.paths['/users/{user-id}/appRoleAssignments/$count'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Applications Users.app Role Assignment API
  version: 1.0.0
extends: openapi/azure-ad-users-approleassignment-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}/appRoleAssignments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's app role assignments
      effect: read
      questions:
      - Which application roles has a particular user been granted?
      - How do I see every app a user is assigned to in Entra ID?
      instructions:
      - text: List the app role assignments for user {user}.
        slots:
          user: path.user-id
      - text: Show which applications {user} is assigned to.
        slots:
          user: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/appRoleAssignments'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign an app role to a user
      effect: write
      questions:
      - How do I give a user a specific role in an enterprise application?
      - What IDs do I need to assign a user to an app's role?
      instructions:
      - text: Assign user {user} the app role {appRoleId} on resource {resourceId}.
        slots:
          user: path.user-id
          appRoleId: requestBody.appRoleId
          resourceId: requestBody.resourceId
      - text: Grant {user} access to the service principal {resourceId} with role {appRoleId}.
        slots:
          user: path.user-id
          resourceId: requestBody.resourceId
          appRoleId: requestBody.appRoleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/appRoleAssignments/{appRoleAssignment-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of a user's app role assignments
      effect: read
      questions:
      - How do I read the details of one specific app role assignment for a user?
      - Which resource and role does a given assignment on a user grant?
      instructions:
      - text: Get app role assignment {assignment} for user {user}.
        slots:
          assignment: path.appRoleAssignment-id
          user: path.user-id
      - text: Show which app and role assignment {assignment} gives {user}.
        slots:
          assignment: path.appRoleAssignment-id
          user: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/appRoleAssignments/{appRoleAssignment-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an app role from a user
      effect: destructive
      questions:
      - How do I revoke a user's access to an application role?
      - Can I unassign a user from an enterprise app?
      instructions:
      - text: Remove app role assignment {assignment} from user {user}.
        slots:
          assignment: path.appRoleAssignment-id
          user: path.user-id
      - text: Unassign {user} from the app granted by assignment {assignment}.
        slots:
          user: path.user-id
          assignment: path.appRoleAssignment-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/appRoleAssignments/{appRoleAssignment-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a user's app role assignment
      effect: write
      questions:
      - Can I change the role on an existing app role assignment for a user?
      - How do I edit an app role assignment instead of deleting and recreating it?
      instructions:
      - text: Change assignment {assignment} for user {user} to role {appRoleId}.
        slots:
          assignment: path.appRoleAssignment-id
          user: path.user-id
          appRoleId: requestBody.appRoleId
      - text: Update the existing app role assignment {assignment} on {user}.
        slots:
          assignment: path.appRoleAssignment-id
          user: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/appRoleAssignments/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a user's app role assignments
      effect: read
      questions:
      - How many applications is a user assigned to?
      - What's the number of app role assignments a given user holds?
      instructions:
      - text: Count the app role assignments for user {user}.
        slots:
          user: path.user-id
      - text: Tell me how many app roles {user} has been granted.
        slots:
          user: path.user-id
      method: generated
      generated: '2026-10-01'