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

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

7 actions 7 updates phrasing extends openapi/azure-ad-groups-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['/groups/{group-id}/appRoleAssignments'].get
$.paths['/groups/{group-id}/appRoleAssignments'].post
$.paths['/groups/{group-id}/appRoleAssignments/{appRoleAssignment-id}'].get
$.paths['/groups/{group-id}/appRoleAssignments/{appRoleAssignment-id}'].delete
$.paths['/groups/{group-id}/appRoleAssignments/{appRoleAssignment-id}'].patch
$.paths['/groups/{group-id}/appRoleAssignments/$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 Applications Groups.app Role Assignment API
  version: 1.0.0
extends: openapi/azure-ad-groups-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['/groups/{group-id}/appRoleAssignments'].get
  update:
    x-apievangelist-phrasing:
      intent: List app roles granted to a group
      effect: read
      questions:
      - Which application roles has a security group been assigned?
      - Can I filter a group's app role assignments by resource application?
      instructions:
      - text: List the app role assignments granted to group {group}.
        slots:
          group: path.group-id
      - text: Show app roles assigned to group {group} where {filter}.
        slots:
          group: path.group-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/appRoleAssignments'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign an app role to a group
      effect: write
      questions:
      - How do I give every member of a security group an application role?
      - Do dynamic membership groups work when assigning an app role to a group?
      instructions:
      - text: Assign app role {appRoleId} of resource {resourceId} to group {group} as principal {principalId}.
        slots:
          appRoleId: requestBody.appRoleId
          resourceId: requestBody.resourceId
          group: path.group-id
          principalId: requestBody.principalId
      - text: Grant group {group} app role {appRoleId} on service principal {resourceId}.
        slots:
          group: path.group-id
          appRoleId: requestBody.appRoleId
          resourceId: requestBody.resourceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/appRoleAssignments/{appRoleAssignment-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one app role assignment of a group
      effect: read
      questions:
      - How do I look up a specific app role a group has been granted?
      - Which application and role does a given group assignment point to?
      instructions:
      - text: Get app role assignment {assignment} for group {group}.
        slots:
          assignment: path.appRoleAssignment-id
          group: path.group-id
      - text: Show the resource and role of assignment {assignment} on group {group}.
        slots:
          assignment: path.appRoleAssignment-id
          group: path.group-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/appRoleAssignments/{appRoleAssignment-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an app role from a group
      effect: destructive
      questions:
      - How do I take an application role away from a group?
      - Can revoking a group's app role assignment be conditioned on an ETag?
      instructions:
      - text: Remove app role assignment {assignment} from group {group}.
        slots:
          assignment: path.appRoleAssignment-id
          group: path.group-id
      - text: Revoke assignment {assignment} on group {group} if the ETag is {etag}.
        slots:
          assignment: path.appRoleAssignment-id
          group: path.group-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/appRoleAssignments/{appRoleAssignment-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a group's app role assignment
      effect: write
      questions:
      - Can I change which role an existing group app role assignment grants?
      - Is it possible to patch an app role assignment already granted to a group?
      instructions:
      - text: Change assignment {assignment} on group {group} to app role {appRoleId}.
        slots:
          assignment: path.appRoleAssignment-id
          group: path.group-id
          appRoleId: requestBody.appRoleId
      - text: Update existing app role assignment {assignment} of group {group}.
        slots:
          assignment: path.appRoleAssignment-id
          group: path.group-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/appRoleAssignments/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count app roles assigned to a group
      effect: read
      questions:
      - How many app role assignments does a group have?
      - Do I need the ConsistencyLevel header to count a group's app role assignments with a filter?
      instructions:
      - text: Count the app role assignments on group {group}.
        slots:
          group: path.group-id
      - text: Give me the number of app roles granted to group {group} matching {filter}.
        slots:
          group: path.group-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'