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

API Evangelist conversational phrasing for Applications Service Principals.home Realm Discovery Policy…

7 actions 7 updates phrasing extends openapi/azure-ad-serviceprincipals-homerealmdiscoverypolicy-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}/homeRealmDiscoveryPolicies'].get
$.paths['/servicePrincipals/{servicePrincipal-id}/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}/$ref'].delete
$.paths['/servicePrincipals/{servicePrincipal-id}/homeRealmDiscoveryPolicies/$count'].get
$.paths['/servicePrincipals/{servicePrincipal-id}/homeRealmDiscoveryPolicies/$ref'].get
$.paths['/servicePrincipals/{servicePrincipal-id}/homeRealmDiscoveryPolicies/$ref'].post
$.paths['/servicePrincipals/{servicePrincipal-id}/homeRealmDiscoveryPolicies/$ref'].delete

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.home Realm Discovery Policy…
  version: 1.0.0
extends: openapi/azure-ad-serviceprincipals-homerealmdiscoverypolicy-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}/homeRealmDiscoveryPolicies'].get
  update:
    x-apievangelist-phrasing:
      intent: List home realm discovery policies on an app
      effect: read
      questions:
      - Which home realm discovery policies are assigned to a service principal?
      - What sign-in routing policy applies to one of my enterprise apps?
      instructions:
      - text: List the home realm discovery policies assigned to service principal {sp}.
        slots:
          sp: path.servicePrincipal-id
      - text: Show HRD policies 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}/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}/$ref'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an HRD policy from an app by policy ID
      effect: destructive
      questions:
      - How do I unassign a specific home realm discovery policy from a service principal by its ID?
      - Can I detach one HRD policy from an app without deleting the policy?
      instructions:
      - text: Remove home realm discovery policy {policy} from service principal {sp}.
        slots:
          policy: path.homeRealmDiscoveryPolicy-id
          sp: path.servicePrincipal-id
      - text: Unassign HRD policy {policy} (by path ID) from app {sp}.
        slots:
          policy: path.homeRealmDiscoveryPolicy-id
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/homeRealmDiscoveryPolicies/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count HRD policies on a service principal
      effect: read
      questions:
      - How many home realm discovery policies are assigned to one service principal?
      - What is the number of HRD policies on an enterprise app?
      instructions:
      - text: Count the home realm discovery policies on service principal {sp}.
        slots:
          sp: path.servicePrincipal-id
      - text: Give me the number of HRD policies assigned to {sp}.
        slots:
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/homeRealmDiscoveryPolicies/$ref'].get
  update:
    x-apievangelist-phrasing:
      intent: List references to an app's HRD policies
      effect: read
      questions:
      - Can I get just the $ref links of HRD policies assigned to a service principal?
      - What reference IDs point to the home realm discovery policies on an app?
      instructions:
      - text: List the $ref links of HRD policies on service principal {sp}.
        slots:
          sp: path.servicePrincipal-id
      - text: Show only reference IDs of home realm discovery policies assigned to {sp}.
        slots:
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/homeRealmDiscoveryPolicies/$ref'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign an HRD policy to a service principal
      effect: write
      questions:
      - How do I assign a home realm discovery policy to an enterprise app?
      - Can I control sign-in routing for one app by attaching an HRD policy?
      instructions:
      - text: Assign home realm discovery policy {ref} to service principal {sp}.
        slots:
          ref: requestBody.@odata.id
          sp: path.servicePrincipal-id
      - text: Attach HRD policy reference {ref} to app {sp}.
        slots:
          ref: requestBody.@odata.id
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/homeRealmDiscoveryPolicies/$ref'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an HRD policy from an app by reference
      effect: destructive
      questions:
      - How do I unassign an HRD policy from a service principal using its @id reference?
      - Can I remove a home realm discovery policy link by passing its reference URL?
      instructions:
      - text: Remove the HRD policy with reference {ref} from service principal {sp}.
        slots:
          ref: query.@id
          sp: path.servicePrincipal-id
      - text: Unlink home realm discovery policy {ref} from app {sp} via the @id query.
        slots:
          ref: query.@id
          sp: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'