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

API Evangelist conversational phrasing for Groups.resource Specific Permission Grant API

7 actions 7 updates phrasing extends openapi/azure-ad-groups-resourcespecificpermissiongrant-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}/permissionGrants'].get
$.paths['/groups/{group-id}/permissionGrants'].post
$.paths['/groups/{group-id}/permissionGrants/{resourceSpecificPermissionGrant-id}'].get
$.paths['/groups/{group-id}/permissionGrants/{resourceSpecificPermissionGrant-id}'].delete
$.paths['/groups/{group-id}/permissionGrants/{resourceSpecificPermissionGrant-id}'].patch
$.paths['/groups/{group-id}/permissionGrants/$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 Groups.resource Specific Permission Grant API
  version: 1.0.0
extends: openapi/azure-ad-groups-resourcespecificpermissiongrant-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}/permissionGrants'].get
  update:
    x-apievangelist-phrasing:
      intent: List apps with resource-specific access to a group
      effect: read
      questions:
      - Which Microsoft Entra apps have been granted access to this group?
      - What resource-specific permissions do apps hold on a team or group?
      instructions:
      - text: List the resource-specific permission grants on group {group}.
        slots:
          group: path.group-id
      - text: Show which apps can access group {group} and with what permissions.
        slots:
          group: path.group-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/permissionGrants'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant an app a resource-specific permission on a group
      effect: write
      questions:
      - How do I give an app a resource-specific permission scoped to one group?
      - Can I add a permission grant for a client app on a single group?
      instructions:
      - text: Grant app {clientAppId} the permission {permission} on group {group}.
        slots:
          clientAppId: requestBody.clientAppId
          permission: requestBody.permission
          group: path.group-id
      - text: Add a {permissionType} permission grant of {permission} for group {group}.
        slots:
          permissionType: requestBody.permissionType
          permission: requestBody.permission
          group: path.group-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/permissionGrants/{resourceSpecificPermissionGrant-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one permission grant on a group
      effect: read
      questions:
      - Can I look up a single resource-specific permission grant on a group?
      - What app and permission does a particular group grant refer to?
      instructions:
      - text: Get permission grant {grant} on group {group}.
        slots:
          grant: path.resourceSpecificPermissionGrant-id
          group: path.group-id
      - text: Show the app and permission behind grant {grant} for group {group}.
        slots:
          grant: path.resourceSpecificPermissionGrant-id
          group: path.group-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/permissionGrants/{resourceSpecificPermissionGrant-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke an app's permission grant on a group
      effect: destructive
      questions:
      - How do I revoke an app's resource-specific access to a group?
      - Can I remove a single permission grant from a group?
      instructions:
      - text: Revoke permission grant {grant} on group {group}.
        slots:
          grant: path.resourceSpecificPermissionGrant-id
          group: path.group-id
      - text: Delete grant {grant} from group {group} if its ETag is {etag}.
        slots:
          grant: path.resourceSpecificPermissionGrant-id
          group: path.group-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/permissionGrants/{resourceSpecificPermissionGrant-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an existing permission grant on a group
      effect: write
      questions:
      - How do I change the permission on an existing app grant for a group?
      - Can I switch the permission type of a group grant I already made?
      instructions:
      - text: Change grant {grant} on group {group} to permission {permission}.
        slots:
          grant: path.resourceSpecificPermissionGrant-id
          group: path.group-id
          permission: requestBody.permission
      - text: Set the permission type of existing grant {grant} on group {group} to {permissionType}.
        slots:
          grant: path.resourceSpecificPermissionGrant-id
          group: path.group-id
          permissionType: requestBody.permissionType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/permissionGrants/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count permission grants on a group
      effect: read
      questions:
      - How many app permission grants exist on this group?
      - What's the number of resource-specific grants for a group?
      instructions:
      - text: Count the permission grants on group {group}.
        slots:
          group: path.group-id
      - text: Tell me how many apps hold resource-specific grants on group {group}.
        slots:
          group: path.group-id
      method: generated
      generated: '2026-10-01'