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

API Evangelist conversational phrasing for Identity.SignIns Identity.identity Verified ID Root API

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

$.info
$.paths['/identity/verifiedId'].get
$.paths['/identity/verifiedId'].delete
$.paths['/identity/verifiedId'].patch
$.paths['/identity/verifiedId/profiles'].get
$.paths['/identity/verifiedId/profiles'].post
$.paths['/identity/verifiedId/profiles/{verifiedIdProfile-id}'].get
$.paths['/identity/verifiedId/profiles/{verifiedIdProfile-id}'].delete
$.paths['/identity/verifiedId/profiles/{verifiedIdProfile-id}'].patch
$.paths['/identity/verifiedId/profiles/$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.identity Verified ID Root API
  version: 1.0.0
extends: openapi/azure-ad-identity-identityverifiedidroot-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: 9
- target: $.paths['/identity/verifiedId'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Verified ID root configuration
      effect: read
      questions:
      - How do I read the tenant's Verified ID entry point in Microsoft Entra?
      - What does the top-level Verified ID object for my tenant contain?
      instructions:
      - text: Get the Verified ID root object for this tenant.
      - text: Show my tenant's Verified ID configuration entry point.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/verifiedId'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete the Verified ID root object
      effect: destructive
      questions:
      - Can I remove the whole Verified ID entry point from my tenant's identity settings?
      - What happens if I delete the tenant-level Verified ID object?
      instructions:
      - text: Delete the tenant's Verified ID root object.
      - text: Remove the Verified ID navigation property from identity.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/verifiedId'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the Verified ID root object
      effect: write
      questions:
      - Can I patch the tenant-level Verified ID object and its profiles in one call?
      - Which fields on the Verified ID root can I change?
      instructions:
      - text: Update the Verified ID root to hold profiles {profiles}.
        slots:
          profiles: requestBody.profiles
      - text: Patch the tenant's top-level Verified ID configuration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/verifiedId/profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List Verified ID profiles
      effect: read
      questions:
      - Which Verified ID profiles are configured in my tenant?
      - How do I list all verifiedIdProfile objects with their properties?
      instructions:
      - text: List all Verified ID profiles.
      - text: Show every verification profile configured for Verified ID.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/verifiedId/profiles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Verified ID profile
      effect: write
      questions:
      - How do I set up a new Verified ID profile with Face Check?
      - Can I set a priority and verifier DID when creating a verification profile?
      instructions:
      - text: Create a Verified ID profile named {name} with verifier DID {verifier_did}.
        slots:
          name: requestBody.name
          verifier_did: requestBody.verifierDid
      - text: Add a new verification profile {name} at priority {priority}.
        slots:
          name: requestBody.name
          priority: requestBody.priority
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/verifiedId/profiles/{verifiedIdProfile-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Verified ID profile
      effect: read
      questions:
      - How do I read one Verified ID profile's settings and relationships?
      - What Face Check configuration does a specific verification profile use?
      instructions:
      - text: Get Verified ID profile {profile}.
        slots:
          profile: path.verifiedIdProfile-id
      - text: Show the Face Check and usage settings of verification profile {profile}.
        slots:
          profile: path.verifiedIdProfile-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/verifiedId/profiles/{verifiedIdProfile-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Verified ID profile
      effect: destructive
      questions:
      - How do I delete a Verified ID profile I no longer need?
      - Can I remove one verification profile without touching the others?
      instructions:
      - text: Delete Verified ID profile {profile}.
        slots:
          profile: path.verifiedIdProfile-id
      - text: Remove verification profile {profile} from the tenant.
        slots:
          profile: path.verifiedIdProfile-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/verifiedId/profiles/{verifiedIdProfile-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Verified ID profile
      effect: write
      questions:
      - Can I change the state or priority of an existing Verified ID profile?
      - Which properties of a verification profile can I edit after creating it?
      instructions:
      - text: Set the state of Verified ID profile {profile} to {state}.
        slots:
          profile: path.verifiedIdProfile-id
          state: requestBody.state
      - text: Change the priority of existing verification profile {profile} to {priority}.
        slots:
          profile: path.verifiedIdProfile-id
          priority: requestBody.priority
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/verifiedId/profiles/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count Verified ID profiles
      effect: read
      questions:
      - How many Verified ID profiles does my tenant have?
      - What's the total number of verification profiles configured?
      instructions:
      - text: Count the Verified ID profiles.
      - text: Tell me how many verification profiles exist in the tenant.
      method: generated
      generated: '2026-10-01'