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

API Evangelist conversational phrasing for Applications Service Principals.endpoint API

7 actions 7 updates phrasing extends openapi/azure-ad-serviceprincipals-endpoint-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['/servicePrincipals/{servicePrincipal-id}/endpoints'].get
$.paths['/servicePrincipals/{servicePrincipal-id}/endpoints'].post
$.paths['/servicePrincipals/{servicePrincipal-id}/endpoints/{endpoint-id}'].get
$.paths['/servicePrincipals/{servicePrincipal-id}/endpoints/{endpoint-id}'].delete
$.paths['/servicePrincipals/{servicePrincipal-id}/endpoints/{endpoint-id}'].patch
$.paths['/servicePrincipals/{servicePrincipal-id}/endpoints/$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 Service Principals.endpoint API
  version: 1.0.0
extends: openapi/azure-ad-serviceprincipals-endpoint-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['/servicePrincipals/{servicePrincipal-id}/endpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List a service principal's endpoints
      effect: read
      questions:
      - Which endpoints are registered on a given service principal?
      - Can I see the capabilities and URIs a service principal exposes?
      instructions:
      - text: List endpoints of service principal {sp}.
        slots:
          sp: path.servicePrincipal-id
      - text: Show endpoints on service principal {sp} matching {filter}.
        slots:
          sp: path.servicePrincipal-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/endpoints'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an endpoint to a service principal
      effect: write
      questions:
      - How do I register a new endpoint URI on a service principal?
      - Can I record which provider and capability an endpoint belongs to?
      instructions:
      - text: Add endpoint {uri} with capability {capability} to service principal {sp}.
        slots:
          uri: requestBody.uri
          capability: requestBody.capability
          sp: path.servicePrincipal-id
      - text: Create an endpoint for provider {provider} on service principal {sp}.
        slots:
          provider: requestBody.providerName
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/endpoints/{endpoint-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one service principal endpoint
      effect: read
      questions:
      - What URI and capability does a specific service principal endpoint have?
      - Which provider resource is a given endpoint tied to?
      instructions:
      - text: Show endpoint {endpoint} of service principal {sp}.
        slots:
          endpoint: path.endpoint-id
          sp: path.servicePrincipal-id
      - text: Get the URI of endpoint {endpoint} on {sp}.
        slots:
          endpoint: path.endpoint-id
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/endpoints/{endpoint-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an endpoint from a service principal
      effect: destructive
      questions:
      - How do I delete an endpoint from a service principal?
      - Can I remove a stale endpoint URI from an app's service principal?
      instructions:
      - text: Delete endpoint {endpoint} from service principal {sp}.
        slots:
          endpoint: path.endpoint-id
          sp: path.servicePrincipal-id
      - text: Remove stale endpoint {endpoint} on {sp}.
        slots:
          endpoint: path.endpoint-id
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/endpoints/{endpoint-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a service principal endpoint
      effect: write
      questions:
      - How do I change the URI of an existing service principal endpoint?
      - Can I update the capability recorded for an endpoint?
      instructions:
      - text: Set the URI of endpoint {endpoint} on service principal {sp} to {uri}.
        slots:
          endpoint: path.endpoint-id
          sp: path.servicePrincipal-id
          uri: requestBody.uri
      - text: Change the capability of endpoint {endpoint} on {sp} to {capability}.
        slots:
          endpoint: path.endpoint-id
          sp: path.servicePrincipal-id
          capability: requestBody.capability
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/endpoints/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a service principal's endpoints
      effect: read
      questions:
      - How many endpoints does a given service principal have?
      - Does this service principal have any endpoints registered?
      instructions:
      - text: Count endpoints on service principal {sp}.
        slots:
          sp: path.servicePrincipal-id
      - text: Tell me how many endpoints {sp} exposes.
        slots:
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'