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

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

7 actions 7 updates phrasing extends openapi/azure-ad-identityproviders-identityprovider-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['/identityProviders'].get
$.paths['/identityProviders'].post
$.paths['/identityProviders/{identityProvider-id}'].get
$.paths['/identityProviders/{identityProvider-id}'].delete
$.paths['/identityProviders/{identityProvider-id}'].patch
$.paths['/identityProviders/$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 Identity Providers.identity Provider API
  version: 1.0.0
extends: openapi/azure-ad-identityproviders-identityprovider-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['/identityProviders'].get
  update:
    x-apievangelist-phrasing:
      intent: List identity providers (deprecated endpoint)
      effect: read
      questions:
      - Which external identity providers are configured in my directory on the deprecated endpoint?
      - How do I list all identity providers set up for sign-in?
      instructions:
      - text: List every identity provider in the directory using the deprecated identityProviders endpoint.
      - text: Show identity providers matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identityProviders'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an identity provider (deprecated endpoint)
      effect: write
      questions:
      - Can I register a new social identity provider with a client ID and secret?
      - What details are needed to add an identity provider through the deprecated API?
      instructions:
      - text: Add a {type} identity provider named {name} with client ID {clientId} and secret {clientSecret}.
        slots:
          type: requestBody.type
          name: requestBody.name
          clientId: requestBody.clientId
          clientSecret: requestBody.clientSecret
      - text: Register identity provider {name} of type {type}.
        slots:
          name: requestBody.name
          type: requestBody.type
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identityProviders/{identityProvider-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one identity provider (deprecated endpoint)
      effect: read
      questions:
      - How can I read the settings of one existing identity provider?
      - What client ID and type is a particular identity provider using?
      instructions:
      - text: Get identity provider {identityProvider}.
        slots:
          identityProvider: path.identityProvider-id
      - text: Show the configuration of identity provider {identityProvider}.
        slots:
          identityProvider: path.identityProvider-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identityProviders/{identityProvider-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an identity provider (deprecated endpoint)
      effect: destructive
      questions:
      - Can I remove an identity provider users no longer sign in with?
      - Is deleting an identity provider through the deprecated endpoint still supported?
      instructions:
      - text: Delete identity provider {identityProvider}.
        slots:
          identityProvider: path.identityProvider-id
      - text: Remove the {identityProvider} identity provider from our directory.
        slots:
          identityProvider: path.identityProvider-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identityProviders/{identityProvider-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an identity provider (deprecated endpoint)
      effect: write
      questions:
      - How do I rotate the client secret on an existing identity provider?
      - Can I rename an identity provider that's already configured?
      instructions:
      - text: Update the client secret of identity provider {identityProvider} to {clientSecret}.
        slots:
          identityProvider: path.identityProvider-id
          clientSecret: requestBody.clientSecret
      - text: Rename identity provider {identityProvider} to {name}.
        slots:
          identityProvider: path.identityProvider-id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identityProviders/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count identity providers
      effect: read
      questions:
      - How many identity providers are configured in the tenant?
      - Can I count identity providers of a certain type?
      instructions:
      - text: Count the identity providers in the directory.
      - text: Tell me how many identity providers match {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'