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

API Evangelist conversational phrasing for Identity.SignIns Policies.claims Mapping Policy API

10 actions 10 updates phrasing extends openapi/azure-ad-policies-claimsmappingpolicy-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['/policies/claimsMappingPolicies'].get
$.paths['/policies/claimsMappingPolicies'].post
$.paths['/policies/claimsMappingPolicies/{claimsMappingPolicy-id}'].get
$.paths['/policies/claimsMappingPolicies/{claimsMappingPolicy-id}'].delete
$.paths['/policies/claimsMappingPolicies/{claimsMappingPolicy-id}'].patch
$.paths['/policies/claimsMappingPolicies/{claimsMappingPolicy-id}/appliesTo'].get
$.paths['/policies/claimsMappingPolicies/{claimsMappingPolicy-id}/appliesTo/{directoryObject-id}'].get
$.paths['/policies/claimsMappingPolicies/{claimsMappingPolicy-id}/appliesTo/$count'].get
$.paths['/policies/claimsMappingPolicies/$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 Policies.claims Mapping Policy API
  version: 1.0.0
extends: openapi/azure-ad-policies-claimsmappingpolicy-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['/policies/claimsMappingPolicies'].get
  update:
    x-apievangelist-phrasing:
      intent: List claims-mapping policies
      effect: read
      questions:
      - Which claims-mapping policies are defined in our Entra tenant?
      - Can I search claims-mapping policies by display name?
      instructions:
      - text: List all claims-mapping policies.
      - text: Show claims-mapping policies matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/claimsMappingPolicies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a claims-mapping policy
      effect: write
      questions:
      - How do I customize the claims emitted in tokens for an application?
      - Can I define a new policy that maps which claims go into SAML and OIDC tokens?
      instructions:
      - text: Create a new claims-mapping policy.
      - text: Add a claims-mapping policy for our token customizations.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/claimsMappingPolicies/{claimsMappingPolicy-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a claims-mapping policy
      effect: read
      questions:
      - What does a specific claims-mapping policy's definition look like?
      - Can I expand what a claims-mapping policy is related to when I fetch it?
      instructions:
      - text: Get claims-mapping policy {policy}.
        slots:
          policy: path.claimsMappingPolicy-id
      - text: Show the definition of claims-mapping policy {policy}.
        slots:
          policy: path.claimsMappingPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/claimsMappingPolicies/{claimsMappingPolicy-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a claims-mapping policy
      effect: destructive
      questions:
      - How do I remove a claims-mapping policy I no longer use?
      - Does deleting a claims-mapping policy support an If-Match ETag?
      instructions:
      - text: Delete claims-mapping policy {policy}.
        slots:
          policy: path.claimsMappingPolicy-id
      - text: Remove claims-mapping policy {policy} only if its ETag is {etag}.
        slots:
          policy: path.claimsMappingPolicy-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/claimsMappingPolicies/{claimsMappingPolicy-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a claims-mapping policy
      effect: write
      questions:
      - Can I change the claims an existing claims-mapping policy emits?
      - Is it possible to patch a claims-mapping policy in place?
      instructions:
      - text: Update claims-mapping policy {policy}.
        slots:
          policy: path.claimsMappingPolicy-id
      - text: Edit the properties of existing claims-mapping policy {policy}.
        slots:
          policy: path.claimsMappingPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/claimsMappingPolicies/{claimsMappingPolicy-id}/appliesTo'].get
  update:
    x-apievangelist-phrasing:
      intent: List what a claims-mapping policy applies to
      effect: read
      questions:
      - Which service principals is a claims-mapping policy assigned to?
      - Can a claims-mapping policy be applied to anything other than applications and service principals?
      instructions:
      - text: List the objects claims-mapping policy {policy} applies to.
        slots:
          policy: path.claimsMappingPolicy-id
      - text: Show the first {top} service principals using claims-mapping policy {policy}.
        slots:
          policy: path.claimsMappingPolicy-id
          top: query.$top
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/claimsMappingPolicies/{claimsMappingPolicy-id}/appliesTo/{directoryObject-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one object a claims-mapping policy targets
      effect: read
      questions:
      - How do I check a single directory object that a claims-mapping policy is applied to?
      - Can I select specific fields of an object a claims-mapping policy applies to?
      instructions:
      - text: Get directory object {object} from the applies-to list of claims-mapping policy {policy}.
        slots:
          object: path.directoryObject-id
          policy: path.claimsMappingPolicy-id
      - text: Show the target {object} that claims-mapping policy {policy} is assigned to.
        slots:
          object: path.directoryObject-id
          policy: path.claimsMappingPolicy-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/claimsMappingPolicies/{claimsMappingPolicy-id}/appliesTo/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count objects a claims-mapping policy applies to
      effect: read
      questions:
      - How many apps or service principals use a given claims-mapping policy?
      - Can I count a claims-mapping policy's targets that match a filter?
      instructions:
      - text: Count the objects claims-mapping policy {policy} applies to.
        slots:
          policy: path.claimsMappingPolicy-id
      - text: Give me the number of targets of claims-mapping policy {policy} matching {filter}.
        slots:
          policy: path.claimsMappingPolicy-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/policies/claimsMappingPolicies/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count claims-mapping policies
      effect: read
      questions:
      - How many claims-mapping policies exist in the tenant?
      - Can I count claims-mapping policies that match a search?
      instructions:
      - text: Count all claims-mapping policies.
      - text: Give me the number of claims-mapping policies matching {search}.
        slots:
          search: query.$search
      method: generated
      generated: '2026-10-01'