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

API Evangelist conversational phrasing for Identity.SignIns Identity.custom Authentication Extension…

9 actions 9 updates phrasing extends openapi/azure-ad-identity-customauthenticationextension-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 9

$.info
$.paths['/identity/customAuthenticationExtensions'].get
$.paths['/identity/customAuthenticationExtensions'].post
$.paths['/identity/customAuthenticationExtensions/{customAuthenticationExtension-id}'].get
$.paths['/identity/customAuthenticationExtensions/{customAuthenticationExtension-id}'].delete
$.paths['/identity/customAuthenticationExtensions/{customAuthenticationExtension-id}'].patch
$.paths['/identity/customAuthenticationExtensions/{customAuthenticationExtension-id}/microsoft.graph.validateAuthenticationConfiguration'].post
$.paths['/identity/customAuthenticationExtensions/$count'].get
$.paths['/identity/customAuthenticationExtensions/microsoft.graph.validateAuthenticationConfiguration'].post

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.custom Authentication Extension…
  version: 1.0.0
extends: openapi/azure-ad-identity-customauthenticationextension-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: 8
- target: $.paths['/identity/customAuthenticationExtensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom authentication extensions
      effect: read
      questions:
      - Which custom authentication extensions are registered in my Entra tenant?
      - How do I see all the token issuance and sign-up extension endpoints I've configured?
      instructions:
      - text: List all custom authentication extensions.
      - text: Show every custom authentication extension and its properties.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/customAuthenticationExtensions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom authentication extension
      effect: write
      questions:
      - How do I register a new custom authentication extension that calls my API?
      - Can I choose what happens on error when creating a custom authentication extension?
      instructions:
      - text: Create a custom authentication extension with error behavior {behavior}.
        slots:
          behavior: requestBody.behaviorOnError
      - text: Register a new custom authentication extension.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/customAuthenticationExtensions/{customAuthenticationExtension-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom authentication extension
      effect: read
      questions:
      - How do I read the configuration of one custom authentication extension?
      - What endpoint and error behavior does a specific extension use?
      instructions:
      - text: Get custom authentication extension {extension}.
        slots:
          extension: path.customAuthenticationExtension-id
      - text: Show the settings of authentication extension {extension}.
        slots:
          extension: path.customAuthenticationExtension-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/customAuthenticationExtensions/{customAuthenticationExtension-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom authentication extension
      effect: destructive
      questions:
      - How do I delete a custom authentication extension I'm no longer using?
      - Can I remove one custom extension from the tenant?
      instructions:
      - text: Delete custom authentication extension {extension}.
        slots:
          extension: path.customAuthenticationExtension-id
      - text: Remove authentication extension {extension} from the tenant.
        slots:
          extension: path.customAuthenticationExtension-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/customAuthenticationExtensions/{customAuthenticationExtension-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom authentication extension
      effect: write
      questions:
      - Can I change the on-error behavior of an existing custom authentication extension?
      - Which properties of an extension I already created can I edit?
      instructions:
      - text: Set the error behavior of existing extension {extension} to {behavior}.
        slots:
          extension: path.customAuthenticationExtension-id
          behavior: requestBody.behaviorOnError
      - text: Update custom authentication extension {extension}.
        slots:
          extension: path.customAuthenticationExtension-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/customAuthenticationExtensions/{customAuthenticationExtension-id}/microsoft.graph.validateAuthenticationConfiguration'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a saved extension's endpoint and auth setup
      effect: read
      questions:
      - Is the endpoint and authentication configuration on my existing custom authentication extension valid?
      - How can I re-check a saved custom extension's settings after changing its endpoint?
      instructions:
      - text: Validate the endpoint and authentication configuration of custom extension {extension}.
        slots:
          extension: path.customAuthenticationExtension-id
      - text: Check that saved extension {extension} can still reach its endpoint with its configured auth.
        slots:
          extension: path.customAuthenticationExtension-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/customAuthenticationExtensions/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count custom authentication extensions
      effect: read
      questions:
      - How many custom authentication extensions does my tenant have?
      - What's the total count of custom extensions configured?
      instructions:
      - text: Count the custom authentication extensions.
      - text: Tell me how many custom authentication extensions exist.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/customAuthenticationExtensions/microsoft.graph.validateAuthenticationConfiguration'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate an endpoint and auth setup before saving
      effect: read
      questions:
      - Can I test an endpoint URL and its authentication settings before creating a custom authentication extension?
      - Will a proposed endpoint configuration work for a new extension that I haven't saved yet?
      instructions:
      - text: Validate endpoint configuration {endpoint} before I create a custom authentication extension.
        slots:
          endpoint: requestBody.endpointConfiguration
      - text: Check unsaved auth settings {auth} with endpoint {endpoint} ahead of creating an extension.
        slots:
          auth: requestBody.authenticationConfiguration
          endpoint: requestBody.endpointConfiguration
      method: generated
      generated: '2026-10-01'