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

API Evangelist conversational phrasing for Users.o Auth2 Permission Grant API

4 actions 4 updates phrasing extends openapi/azure-ad-users-oauth2permissiongrant-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 4

$.info
$.paths['/users/{user-id}/oauth2PermissionGrants'].get
$.paths['/users/{user-id}/oauth2PermissionGrants/{oAuth2PermissionGrant-id}'].get
$.paths['/users/{user-id}/oauth2PermissionGrants/$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 Users.o Auth2 Permission Grant API
  version: 1.0.0
extends: openapi/azure-ad-users-oauth2permissiongrant-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: 3
- target: $.paths['/users/{user-id}/oauth2PermissionGrants'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's delegated permission grants
      effect: read
      questions:
      - Which apps has a user granted delegated permissions to act on their behalf?
      - Can I filter a user's OAuth2 permission grants by client application?
      instructions:
      - text: List the delegated permission grants for user {user}.
        slots:
          user: path.user-id
      - text: List OAuth2 permission grants for user {user} matching {filter}.
        slots:
          user: path.user-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/oauth2PermissionGrants/{oAuth2PermissionGrant-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of a user's delegated permission grants
      effect: read
      questions:
      - What scopes does a specific delegated permission grant give an app for a user?
      - Where can I read the details of one OAuth2 grant on a user?
      instructions:
      - text: Get permission grant {grant} for user {user}.
        slots:
          grant: path.oAuth2PermissionGrant-id
          user: path.user-id
      - text: Show the scopes in delegated grant {grant} of user {user}.
        slots:
          grant: path.oAuth2PermissionGrant-id
          user: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/oauth2PermissionGrants/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a user's delegated permission grants
      effect: read
      questions:
      - How many delegated permission grants does a given user have?
      - Can I count only the grants that match a filter?
      instructions:
      - text: Count the OAuth2 permission grants for user {user}.
        slots:
          user: path.user-id
      - text: Count delegated grants for user {user} matching {filter}.
        slots:
          user: path.user-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'