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

API Evangelist conversational phrasing for Identity.SignIns Identity.identity Provider Base API

8 actions 8 updates phrasing extends openapi/azure-ad-identity-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['/identity/identityProviders'].get
$.paths['/identity/identityProviders'].post
$.paths['/identity/identityProviders/{identityProviderBase-id}'].get
$.paths['/identity/identityProviders/{identityProviderBase-id}'].delete
$.paths['/identity/identityProviders/{identityProviderBase-id}'].patch
$.paths['/identity/identityProviders/$count'].get
$.paths['/identity/identityProviders/microsoft.graph.availableProviderTypes()'].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 Identity.identity Provider Base API
  version: 1.0.0
extends: openapi/azure-ad-identity-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['/identity/identityProviders'].get
  update:
    x-apievangelist-phrasing:
      intent: List configured identity providers
      effect: read
      questions:
      - Which identity providers, like Google or SAML federation, are configured in my tenant?
      - How do I see every social and federated identity provider set up for sign-in?
      instructions:
      - text: List the identity providers configured in the tenant.
      - text: Show configured identity providers matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/identityProviders'].post
  update:
    x-apievangelist-phrasing:
      intent: Configure a new identity provider
      effect: write
      questions:
      - How do I add a social identity provider so users can sign in with it?
      - What's required to create a new identity provider in my tenant?
      instructions:
      - text: Create an identity provider named {displayName}.
        slots:
          displayName: requestBody.displayName
      - text: Set up a new sign-in identity provider called {displayName}.
        slots:
          displayName: requestBody.displayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/identityProviders/{identityProviderBase-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a configured identity provider
      effect: read
      questions:
      - How do I look up the settings of one identity provider in my tenant?
      - What type and properties does a specific configured identity provider have?
      instructions:
      - text: Get identity provider {provider}.
        slots:
          provider: path.identityProviderBase-id
      - text: Show the configuration of sign-in provider {provider}.
        slots:
          provider: path.identityProviderBase-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/identityProviders/{identityProviderBase-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an identity provider
      effect: destructive
      questions:
      - How do I stop users signing in with a social provider I configured?
      - Can I delete an identity provider from my tenant by ID?
      instructions:
      - text: Delete identity provider {provider}.
        slots:
          provider: path.identityProviderBase-id
      - text: Remove sign-in provider {provider} from the tenant.
        slots:
          provider: path.identityProviderBase-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/identityProviders/{identityProviderBase-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an identity provider
      effect: write
      questions:
      - How do I rename or reconfigure an identity provider I already set up?
      - Can I change the settings of an existing federated identity provider?
      instructions:
      - text: Rename identity provider {provider} to {displayName}.
        slots:
          provider: path.identityProviderBase-id
          displayName: requestBody.displayName
      - text: Update the configuration of sign-in provider {provider}.
        slots:
          provider: path.identityProviderBase-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/identityProviders/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count configured identity providers
      effect: read
      questions:
      - How many identity providers are configured in my tenant?
      - What's the total number of sign-in providers set up?
      instructions:
      - text: Count the configured identity providers.
      - text: Tell me how many sign-in providers the tenant has.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/identityProviders/microsoft.graph.availableProviderTypes()'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity provider types the directory supports
      effect: read
      questions:
      - Which kinds of identity providers can I add to my directory?
      - What provider types are supported before I configure a new one?
      instructions:
      - text: List the identity provider types supported in this directory.
      - text: Show which provider types I'm allowed to configure.
      method: generated
      generated: '2026-10-01'