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

API Evangelist conversational phrasing for Applications Service Principals.o Auth2 Permission Grant API

4 actions 4 updates phrasing extends openapi/azure-ad-serviceprincipals-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['/servicePrincipals/{servicePrincipal-id}/oauth2PermissionGrants'].get

$.paths['/servicePrincipals/{servicePrincipal-id}/oauth2PermissionGrants/{oAuth2PermissionGrant-id}'].get

$.paths['/servicePrincipals/{servicePrincipal-id}/oauth2PermissionGrants/$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 Service Principals.o Auth2 Permission Grant API
  version: 1.0.0
extends: openapi/azure-ad-serviceprincipals-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['/servicePrincipals/{servicePrincipal-id}/oauth2PermissionGrants'].get
  update:
    x-apievangelist-phrasing:
      intent: List delegated permission grants for an app
      effect: read
      questions:
      - Which delegated permissions have users or admins consented to for a client app?
      - How do I audit the OAuth2 permission grants given to a service principal?
      instructions:
      - text: List the delegated permission grants for service principal {sp}.
        slots:
          sp: path.servicePrincipal-id
      - text: Show every OAuth2 consent grant given to client app {sp}.
        slots:
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/oauth2PermissionGrants/{oAuth2PermissionGrant-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one delegated permission grant for an app
      effect: read
      questions:
      - How do I read a single OAuth2 permission grant on a service principal?
      - What scopes does a specific delegated grant give this app on behalf of users?
      instructions:
      - text: Get permission grant {grant} for service principal {sp}.
        slots:
          grant: path.oAuth2PermissionGrant-id
          sp: path.servicePrincipal-id
      - text: Show the scopes in delegated grant {grant} on client app {sp}.
        slots:
          grant: path.oAuth2PermissionGrant-id
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/oauth2PermissionGrants/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count delegated permission grants for an app
      effect: read
      questions:
      - How many delegated permission grants does a service principal have?
      - What's the number of OAuth2 consent grants on a client app?
      instructions:
      - text: Count the delegated permission grants for service principal {sp}.
        slots:
          sp: path.servicePrincipal-id
      - text: Tell me how many OAuth2 grants client app {sp} holds.
        slots:
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'