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

API Evangelist conversational phrasing for Identity.SignIns Identity.risk Prevention Container API

24 actions 24 updates phrasing extends openapi/azure-ad-identity-riskpreventioncontainer-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 24 · first 16 shown; the file carries all of them

$.info
$.paths['/identity/riskPrevention'].get
$.paths['/identity/riskPrevention'].delete
$.paths['/identity/riskPrevention'].patch
$.paths['/identity/riskPrevention/fraudProtectionProviders'].get
$.paths['/identity/riskPrevention/fraudProtectionProviders'].post
$.paths['/identity/riskPrevention/fraudProtectionProviders/{fraudProtectionProvider-id}'].get
$.paths['/identity/riskPrevention/fraudProtectionProviders/{fraudProtectionProvider-id}'].delete
$.paths['/identity/riskPrevention/fraudProtectionProviders/{fraudProtectionProvider-id}'].patch
$.paths['/identity/riskPrevention/fraudProtectionProviders/$count'].get
$.paths['/identity/riskPrevention/webApplicationFirewallProviders'].get
$.paths['/identity/riskPrevention/webApplicationFirewallProviders'].post
$.paths['/identity/riskPrevention/webApplicationFirewallProviders/{webApplicationFirewallProvider-id}'].get
$.paths['/identity/riskPrevention/webApplicationFirewallProviders/{webApplicationFirewallProvider-id}'].delete
$.paths['/identity/riskPrevention/webApplicationFirewallProviders/{webApplicationFirewallProvider-id}'].patch
$.paths['/identity/riskPrevention/webApplicationFirewallProviders/{webApplicationFirewallProvider-id}/microsoft.graph.verify'].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.risk Prevention Container API
  version: 1.0.0
extends: openapi/azure-ad-identity-riskpreventioncontainer-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: 23
- target: $.paths['/identity/riskPrevention'].get
  update:
    x-apievangelist-phrasing:
      intent: Get fraud and risk prevention settings
      effect: read
      questions:
      - Where do I see my tenant's fraud and risk prevention configuration for External ID?
      - What third-party risk prevention settings are set up in Microsoft Entra External ID?
      instructions:
      - text: Show the tenant's risk prevention configuration.
      - text: Get the fraud and risk prevention container with its providers.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete the risk prevention configuration
      effect: destructive
      questions:
      - Can I wipe the whole risk prevention configuration from my tenant?
      - How do I remove all fraud and risk prevention settings at once?
      instructions:
      - text: Delete the tenant's entire risk prevention configuration.
      - text: Remove the riskPrevention container from identity settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the risk prevention configuration
      effect: write
      questions:
      - How do I change the fraud protection and firewall providers in one update to the risk prevention container?
      - Can I replace the set of web application firewall verifications on the risk prevention settings?
      instructions:
      - text: Update risk prevention to use fraud protection providers {fraudProtectionProviders}.
        slots:
          fraudProtectionProviders: requestBody.fraudProtectionProviders
      - text: Set the risk prevention firewall providers to {webApplicationFirewallProviders}.
        slots:
          webApplicationFirewallProviders: requestBody.webApplicationFirewallProviders
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/fraudProtectionProviders'].get
  update:
    x-apievangelist-phrasing:
      intent: List fraud protection providers
      effect: read
      questions:
      - Which fraud protection providers are connected to my External ID tenant?
      - How can I see every fraud protection integration and its settings?
      instructions:
      - text: List all fraud protection providers.
      - text: Show fraud protection providers matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/fraudProtectionProviders'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a fraud protection provider
      effect: write
      questions:
      - How do I connect a new fraud protection provider to my sign-up flows?
      - What do I need to register a fraud protection integration?
      instructions:
      - text: Create a fraud protection provider named {displayName}.
        slots:
          displayName: requestBody.displayName
      - text: Register a new fraud protection integration called {displayName}.
        slots:
          displayName: requestBody.displayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/fraudProtectionProviders/{fraudProtectionProvider-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a fraud protection provider
      effect: read
      questions:
      - How do I look up the settings of one fraud protection provider by ID?
      - What subtype and properties does a specific fraud protection provider have?
      instructions:
      - text: Get fraud protection provider {provider}.
        slots:
          provider: path.fraudProtectionProvider-id
      - text: Show the configuration of fraud protection integration {provider}.
        slots:
          provider: path.fraudProtectionProvider-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/fraudProtectionProviders/{fraudProtectionProvider-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a fraud protection provider
      effect: destructive
      questions:
      - How do I disconnect a fraud protection provider I no longer use?
      - Can I delete one fraud protection integration by its ID?
      instructions:
      - text: Delete fraud protection provider {provider}.
        slots:
          provider: path.fraudProtectionProvider-id
      - text: Disconnect the fraud protection integration {provider}.
        slots:
          provider: path.fraudProtectionProvider-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/fraudProtectionProviders/{fraudProtectionProvider-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a fraud protection provider
      effect: write
      questions:
      - How do I rename or reconfigure an existing fraud protection provider?
      - Can I change the settings of a fraud protection integration after creating it?
      instructions:
      - text: Rename fraud protection provider {provider} to {displayName}.
        slots:
          provider: path.fraudProtectionProvider-id
          displayName: requestBody.displayName
      - text: Update the settings of fraud protection integration {provider}.
        slots:
          provider: path.fraudProtectionProvider-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/fraudProtectionProviders/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count fraud protection providers
      effect: read
      questions:
      - How many fraud protection providers are configured in my tenant?
      - What's the total number of fraud protection integrations?
      instructions:
      - text: Count the fraud protection providers.
      - text: Tell me how many fraud protection integrations exist.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/webApplicationFirewallProviders'].get
  update:
    x-apievangelist-phrasing:
      intent: List web application firewall providers
      effect: read
      questions:
      - Which web application firewall providers are configured for my External ID tenant?
      - How can I see all WAF provider integrations and their properties?
      instructions:
      - text: List all web application firewall providers.
      - text: Show WAF providers matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/webApplicationFirewallProviders'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a web application firewall provider
      effect: write
      questions:
      - How do I register a new web application firewall provider?
      - What's needed to create a WAF provider object for risk prevention?
      instructions:
      - text: Create a web application firewall provider named {displayName}.
        slots:
          displayName: requestBody.displayName
      - text: Register a new WAF provider called {displayName}.
        slots:
          displayName: requestBody.displayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/webApplicationFirewallProviders/{webApplicationFirewallProvider-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a web application firewall provider
      effect: read
      questions:
      - How do I read the details of one WAF provider by its ID?
      - What properties does a specific web application firewall provider have?
      instructions:
      - text: Get web application firewall provider {provider}.
        slots:
          provider: path.webApplicationFirewallProvider-id
      - text: Show the configuration of WAF provider {provider}.
        slots:
          provider: path.webApplicationFirewallProvider-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/webApplicationFirewallProviders/{webApplicationFirewallProvider-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a web application firewall provider
      effect: destructive
      questions:
      - How do I remove a WAF provider I no longer use?
      - Can I delete one web application firewall provider by ID?
      instructions:
      - text: Delete web application firewall provider {provider}.
        slots:
          provider: path.webApplicationFirewallProvider-id
      - text: Remove WAF provider {provider} from risk prevention.
        slots:
          provider: path.webApplicationFirewallProvider-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/webApplicationFirewallProviders/{webApplicationFirewallProvider-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a web application firewall provider
      effect: write
      questions:
      - How do I rename or change settings on an existing WAF provider?
      - Can I edit a web application firewall provider after it's registered?
      instructions:
      - text: Rename web application firewall provider {provider} to {displayName}.
        slots:
          provider: path.webApplicationFirewallProvider-id
          displayName: requestBody.displayName
      - text: Update the settings of WAF provider {provider}.
        slots:
          provider: path.webApplicationFirewallProvider-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/webApplicationFirewallProviders/{webApplicationFirewallProvider-id}/microsoft.graph.verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a host with a WAF provider
      effect: write
      questions:
      - How do I check that my domain is actually protected by my web application firewall provider?
      - Can I trigger a WAF verification for a specific host name?
      instructions:
      - text: Verify host {hostName} with WAF provider {provider}.
        slots:
          hostName: requestBody.hostName
          provider: path.webApplicationFirewallProvider-id
      - text: Run a firewall verification of {hostName} using provider {provider}.
        slots:
          hostName: requestBody.hostName
          provider: path.webApplicationFirewallProvider-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/webApplicationFirewallProviders/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count web application firewall providers
      effect: read
      questions:
      - How many WAF providers are set up in my tenant?
      - What's the number of web application firewall providers configured?
      instructions:
      - text: Count the web application firewall providers.
      - text: Tell me how many WAF providers exist.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/webApplicationFirewallVerifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List WAF verification results
      effect: read
      questions:
      - Which hosts have been verified against a web application firewall, and what were the results?
      - How do I see all past WAF verification records?
      instructions:
      - text: List all web application firewall verification results.
      - text: Show WAF verifications matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/webApplicationFirewallVerifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a WAF verification result
      effect: write
      questions:
      - Can I store a web application firewall verification record for a host directly?
      - What fields go into a new WAF verification model entry?
      instructions:
      - text: Create a WAF verification record for host {verifiedHost}.
        slots:
          verifiedHost: requestBody.verifiedHost
      - text: Record a firewall verification of {verifiedHost} with provider type {providerType}.
        slots:
          verifiedHost: requestBody.verifiedHost
          providerType: requestBody.providerType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/webApplicationFirewallVerifications/{webApplicationFirewallVerificationModel-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a WAF verification result
      effect: read
      questions:
      - How do I read one web application firewall verification by its ID?
      - What was the outcome of a specific WAF host verification?
      instructions:
      - text: Get WAF verification {verification}.
        slots:
          verification: path.webApplicationFirewallVerificationModel-id
      - text: Show the result of firewall verification {verification}.
        slots:
          verification: path.webApplicationFirewallVerificationModel-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/webApplicationFirewallVerifications/{webApplicationFirewallVerificationModel-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a WAF verification result
      effect: destructive
      questions:
      - Can I delete an old web application firewall verification record?
      - How do I remove one WAF verification by ID?
      instructions:
      - text: Delete WAF verification {verification}.
        slots:
          verification: path.webApplicationFirewallVerificationModel-id
      - text: Remove firewall verification record {verification}.
        slots:
          verification: path.webApplicationFirewallVerificationModel-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/webApplicationFirewallVerifications/{webApplicationFirewallVerificationModel-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a WAF verification result
      effect: write
      questions:
      - How do I change the verified host or result on an existing WAF verification?
      - Can I edit a web application firewall verification record after it's stored?
      instructions:
      - text: Set the verified host of WAF verification {verification} to {verifiedHost}.
        slots:
          verification: path.webApplicationFirewallVerificationModel-id
          verifiedHost: requestBody.verifiedHost
      - text: Update the result of firewall verification {verification} to {verificationResult}.
        slots:
          verification: path.webApplicationFirewallVerificationModel-id
          verificationResult: requestBody.verificationResult
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/webApplicationFirewallVerifications/{webApplicationFirewallVerificationModel-id}/provider'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the WAF provider behind a verification
      effect: read
      questions:
      - Which firewall provider was used for a particular WAF verification?
      - How do I find the provider linked to a web application firewall verification record?
      instructions:
      - text: Show the WAF provider used by verification {verification}.
        slots:
          verification: path.webApplicationFirewallVerificationModel-id
      - text: Which provider verified the host in record {verification}? Get it.
        slots:
          verification: path.webApplicationFirewallVerificationModel-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/identity/riskPrevention/webApplicationFirewallVerifications/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count WAF verification results
      effect: read
      questions:
      - How many web application firewall verifications have been recorded?
      - What's the total count of WAF verification records?
      instructions:
      - text: Count the web application firewall verifications.
      - text: Tell me how many WAF verification records exist.
      method: generated
      generated: '2026-10-01'