# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Identity.DirectoryManagement Domains.internal Domain…
  version: 1.0.0
extends: openapi/azure-ad-domains-internaldomainfederation-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['/domains/{domain-id}/federationConfiguration'].get
  update:
    x-apievangelist-phrasing:
      intent: List a domain's federation configuration
      effect: read
      questions:
      - How do I see the federation settings for a domain federated with an external identity provider?
      - Why does listing a domain's federation configuration only ever return one object?
      instructions:
      - text: List the federation configuration for domain {domain}.
        slots:
          domain: path.domain-id
      - text: Show which identity provider federation is set on domain {domain}.
        slots:
          domain: path.domain-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/federationConfiguration'].post
  update:
    x-apievangelist-phrasing:
      intent: Federate a domain with an identity provider
      effect: write
      questions:
      - How do I set up federation for a domain in Microsoft Entra ID?
      - Can I set the sign-in and sign-out URIs when federating a domain?
      instructions:
      - text: Create a federation configuration for domain {domain} with sign-in URI {sign_in_uri}.
        slots:
          domain: path.domain-id
          sign_in_uri: requestBody.activeSignInUri
      - text: Federate domain {domain} and use {sign_out_uri} as the sign-out address.
        slots:
          domain: path.domain-id
          sign_out_uri: requestBody.signOutUri
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/federationConfiguration/{internalDomainFederation-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a domain's federation settings
      effect: read
      questions:
      - How do I read one internalDomainFederation object for a domain?
      - What MFA behavior and signing certificate does my federated domain use?
      instructions:
      - text: Get federation configuration {federation} for domain {domain}.
        slots:
          federation: path.internalDomainFederation-id
          domain: path.domain-id
      - text: Show the MFA and certificate settings of federation {federation} on domain {domain}.
        slots:
          federation: path.internalDomainFederation-id
          domain: path.domain-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/federationConfiguration/{internalDomainFederation-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove federation from a domain
      effect: destructive
      questions:
      - How do I delete the federation configuration from a domain?
      - Can I defederate a domain by removing its internalDomainFederation object?
      instructions:
      - text: Delete federation configuration {federation} from domain {domain}.
        slots:
          federation: path.internalDomainFederation-id
          domain: path.domain-id
      - text: Defederate domain {domain} by removing federation {federation}.
        slots:
          domain: path.domain-id
          federation: path.internalDomainFederation-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/federationConfiguration/{internalDomainFederation-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a domain's federation settings
      effect: write
      questions:
      - Can I roll over the next signing certificate on an already federated domain?
      - How do I change the federated IdP MFA behavior for an existing domain federation?
      instructions:
      - text: Set the next signing certificate on federation {federation} of domain {domain} to {certificate}.
        slots:
          federation: path.internalDomainFederation-id
          domain: path.domain-id
          certificate: requestBody.nextSigningCertificate
      - text: Change the MFA behavior of existing federation {federation} on domain {domain} to {mfa_behavior}.
        slots:
          federation: path.internalDomainFederation-id
          domain: path.domain-id
          mfa_behavior: requestBody.federatedIdpMfaBehavior
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domains/{domain-id}/federationConfiguration/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a domain's federation configurations
      effect: read
      questions:
      - Is a given domain federated at all, judging by the count of its federation configurations?
      - What's the number of federation configurations on a domain?
      instructions:
      - text: Count the federation configurations on domain {domain}.
        slots:
          domain: path.domain-id
      - text: Tell me how many federation objects domain {domain} has.
        slots:
          domain: path.domain-id
      method: generated
      generated: '2026-10-01'