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

API Evangelist conversational phrasing for Identity.DirectoryManagement Directory.identity Provider…

8 actions 8 updates phrasing extends openapi/azure-ad-directory-identityproviderbase-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 8

$.info

$.paths['/directory/federationConfigurations'].get

$.paths['/directory/federationConfigurations'].post

$.paths['/directory/federationConfigurations/{identityProviderBase-id}'].get

$.paths['/directory/federationConfigurations/{identityProviderBase-id}'].delete

$.paths['/directory/federationConfigurations/{identityProviderBase-id}'].patch

$.paths['/directory/federationConfigurations/$count'].get

$.paths['/directory/federationConfigurations/microsoft.graph.availableProviderTypes()'].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 Identity.DirectoryManagement Directory.identity Provider…
  version: 1.0.0
extends: openapi/azure-ad-directory-identityproviderbase-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: 7
- target: $.paths['/directory/federationConfigurations'].get
  update:
    x-apievangelist-phrasing:
      intent: List SAML/WS-Fed federation configurations
      effect: read
      questions:
      - Which external organizations are federated with my tenant over SAML or WS-Fed?
      - Can I filter domain federation configurations by display name?
      instructions:
      - text: List all SAML and WS-Fed federation configurations.
      - text: Show federation configurations matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/federationConfigurations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a federation configuration
      effect: write
      questions:
      - How do I set up domain federation with a partner's SAML identity provider?
      - Can I add a WS-Fed external identity provider for guest sign-in?
      instructions:
      - text: Create a federation configuration named {name}.
        slots:
          name: requestBody.displayName
      - text: Add external SAML or WS-Fed identity provider {name}.
        slots:
          name: requestBody.displayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/federationConfigurations/{identityProviderBase-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a federation configuration
      effect: read
      questions:
      - What are the settings of a specific external domain federation?
      - Which identity provider backs a particular federation configuration?
      instructions:
      - text: Show federation configuration {idp}.
        slots:
          idp: path.identityProviderBase-id
      - text: Get the details of external identity provider {idp}.
        slots:
          idp: path.identityProviderBase-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/federationConfigurations/{identityProviderBase-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a SAML/WS-Fed federation
      effect: destructive
      questions:
      - How do I remove federation with a partner organization's identity provider?
      - Can I delete a samlOrWsFedExternalDomainFederation object?
      instructions:
      - text: Delete federation configuration {idp}.
        slots:
          idp: path.identityProviderBase-id
      - text: Remove external domain federation {idp} if its ETag is {etag}.
        slots:
          idp: path.identityProviderBase-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/federationConfigurations/{identityProviderBase-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a federation configuration
      effect: write
      questions:
      - How do I rename an existing external identity provider federation?
      - Can I edit a SAML federation configuration after creating it?
      instructions:
      - text: Rename federation configuration {idp} to {name}.
        slots:
          idp: path.identityProviderBase-id
          name: requestBody.displayName
      - text: Update external identity provider {idp}.
        slots:
          idp: path.identityProviderBase-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/federationConfigurations/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count federation configurations
      effect: read
      questions:
      - How many SAML or WS-Fed federations does my tenant have?
      - Is any external domain federation configured at all?
      instructions:
      - text: Count the federation configurations.
      - text: Count federation configurations matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/directory/federationConfigurations/microsoft.graph.availableProviderTypes()'].get
  update:
    x-apievangelist-phrasing:
      intent: List supported identity provider types
      effect: read
      questions:
      - What identity provider types can my directory federate with?
      - Is SAML/WS-Fed a supported provider type in this tenant?
      instructions:
      - text: List the identity provider types supported in the directory.
      - text: Show available federation provider types.
      method: generated
      generated: '2026-10-01'