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

API Evangelist conversational phrasing for Identity.SignIns Policies.home Realm Discovery Policy API

10 actions 10 updates phrasing extends openapi/azure-ad-policies-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 10

$.info
$.paths['/policies/homeRealmDiscoveryPolicies'].get
$.paths['/policies/homeRealmDiscoveryPolicies'].post
$.paths['/policies/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}'].get
$.paths['/policies/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}'].delete
$.paths['/policies/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}'].patch
$.paths['/policies/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}/appliesTo'].get
$.paths['/policies/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}/appliesTo/{directoryObject-id}'].get
$.paths['/policies/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}/appliesTo/$count'].get
$.paths['/policies/homeRealmDiscoveryPolicies/$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 Identity.SignIns Policies.home Realm Discovery Policy API
  version: 1.0.0
extends: openapi/azure-ad-policies-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: 9
- target: $.paths['/policies/homeRealmDiscoveryPolicies'].get
  update:
    x-apievangelist-phrasing:
      intent: List home realm discovery policies
      effect: read
      questions:
      - Which home realm discovery policies exist in my tenant?
      - Can I see all the policies that control where users are sent to sign in?
      instructions:
      - text: List all home realm discovery policies.
      - text: Show the first {top} home realm discovery policies.
        slots:
          top: query.$top
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/homeRealmDiscoveryPolicies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a home realm discovery policy
      effect: write
      questions:
      - How do I create a new home realm discovery policy?
      - Can I add a policy that controls sign-in redirection to a federated identity provider?
      instructions:
      - text: Create a new home realm discovery policy.
      - text: Add a home realm discovery policy to the tenant for sign-in acceleration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a home realm discovery policy
      effect: read
      questions:
      - What are the properties and definition of one home realm discovery policy?
      - Is a particular home realm discovery policy set as the organization default?
      instructions:
      - text: Get home realm discovery policy {policy}.
        slots:
          policy: path.homeRealmDiscoveryPolicy-id
      - text: Show the definition and relationships of HRD policy {policy}.
        slots:
          policy: path.homeRealmDiscoveryPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a home realm discovery policy
      effect: destructive
      questions:
      - Can I remove a home realm discovery policy I no longer need?
      - What happens to sign-in routing when a home realm discovery policy is deleted?
      instructions:
      - text: Delete home realm discovery policy {policy}.
        slots:
          policy: path.homeRealmDiscoveryPolicy-id
      - text: Remove HRD policy {policy} from the tenant.
        slots:
          policy: path.homeRealmDiscoveryPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a home realm discovery policy
      effect: write
      questions:
      - Can I change the settings of an existing home realm discovery policy?
      - Which properties of a home realm discovery policy can I edit?
      instructions:
      - text: Update the properties of home realm discovery policy {policy}.
        slots:
          policy: path.homeRealmDiscoveryPolicy-id
      - text: Edit HRD policy {policy} with new settings.
        slots:
          policy: path.homeRealmDiscoveryPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}/appliesTo'].get
  update:
    x-apievangelist-phrasing:
      intent: List objects a home realm discovery policy applies to
      effect: read
      questions:
      - Which applications or service principals is a home realm discovery policy assigned to?
      - Where has a given HRD policy been applied?
      instructions:
      - text: List the directory objects home realm discovery policy {policy} applies to.
        slots:
          policy: path.homeRealmDiscoveryPolicy-id
      - text: Show every app that HRD policy {policy} is assigned to.
        slots:
          policy: path.homeRealmDiscoveryPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}/appliesTo/{directoryObject-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one object a home realm discovery policy applies to
      effect: read
      questions:
      - Can I check a single object that a home realm discovery policy has been applied to?
      - What are the details of one target of an HRD policy?
      instructions:
      - text: Get applied object {object} of home realm discovery policy {policy}.
        slots:
          object: path.directoryObject-id
          policy: path.homeRealmDiscoveryPolicy-id
      - text: Show target {object} that HRD policy {policy} is applied to.
        slots:
          object: path.directoryObject-id
          policy: path.homeRealmDiscoveryPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/homeRealmDiscoveryPolicies/{homeRealmDiscoveryPolicy-id}/appliesTo/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count objects a home realm discovery policy applies to
      effect: read
      questions:
      - How many objects is a home realm discovery policy applied to?
      - What is the number of apps assigned one HRD policy?
      instructions:
      - text: Count the objects home realm discovery policy {policy} applies to.
        slots:
          policy: path.homeRealmDiscoveryPolicy-id
      - text: Tell me how many targets HRD policy {policy} has.
        slots:
          policy: path.homeRealmDiscoveryPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/homeRealmDiscoveryPolicies/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count home realm discovery policies
      effect: read
      questions:
      - How many home realm discovery policies does my tenant have?
      - What is the total of HRD policies defined?
      instructions:
      - text: Count the home realm discovery policies in the tenant.
      - text: Tell me how many HRD policies exist.
      method: generated
      generated: '2026-10-01'