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

API Evangelist conversational phrasing for Applications Service Principals.claims Mapping Policy API

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

$.info
$.paths['/servicePrincipals/{servicePrincipal-id}/claimsMappingPolicies'].get
$.paths['/servicePrincipals/{servicePrincipal-id}/claimsMappingPolicies/{claimsMappingPolicy-id}/$ref'].delete
$.paths['/servicePrincipals/{servicePrincipal-id}/claimsMappingPolicies/$count'].get
$.paths['/servicePrincipals/{servicePrincipal-id}/claimsMappingPolicies/$ref'].get
$.paths['/servicePrincipals/{servicePrincipal-id}/claimsMappingPolicies/$ref'].post
$.paths['/servicePrincipals/{servicePrincipal-id}/claimsMappingPolicies/$ref'].delete

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 Applications Service Principals.claims Mapping Policy API
  version: 1.0.0
extends: openapi/azure-ad-serviceprincipals-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: 6
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/claimsMappingPolicies'].get
  update:
    x-apievangelist-phrasing:
      intent: List claims mapping policies on a service principal
      effect: read
      questions:
      - Which claims mapping policies are assigned to this service principal?
      - How do I see the full claims mapping policy objects applied to an enterprise app?
      instructions:
      - text: List the claims mapping policies assigned to service principal {servicePrincipal}.
        slots:
          servicePrincipal: path.servicePrincipal-id
      - text: Show full claims mapping policy details for app {servicePrincipal}.
        slots:
          servicePrincipal: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/claimsMappingPolicies/{claimsMappingPolicy-id}/$ref'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassign a claims mapping policy by id
      effect: destructive
      questions:
      - How do I remove a specific claims mapping policy from a service principal using the policy id in the path?
      - Does unassigning a claims mapping policy delete the policy itself?
      instructions:
      - text: Remove claims mapping policy {policy} from service principal {servicePrincipal}.
        slots:
          policy: path.claimsMappingPolicy-id
          servicePrincipal: path.servicePrincipal-id
      - text: Unassign policy {policy} from app {servicePrincipal} via its path reference.
        slots:
          policy: path.claimsMappingPolicy-id
          servicePrincipal: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/claimsMappingPolicies/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count claims mapping policies on a service principal
      effect: read
      questions:
      - How many claims mapping policies are assigned to one service principal?
      - Is there more than one claims mapping policy on this app?
      instructions:
      - text: Count claims mapping policies on service principal {servicePrincipal}.
        slots:
          servicePrincipal: path.servicePrincipal-id
      - text: Tell me how many claims mapping policies app {servicePrincipal} has.
        slots:
          servicePrincipal: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/claimsMappingPolicies/$ref'].get
  update:
    x-apievangelist-phrasing:
      intent: List claims mapping policy references
      effect: read
      questions:
      - Can I get just the references (@odata.id links) for claims mapping policies on a service principal?
      - What are the reference links of the policies assigned to this app, without the full objects?
      instructions:
      - text: List the claims mapping policy references on service principal {servicePrincipal}.
        slots:
          servicePrincipal: path.servicePrincipal-id
      - text: Get only the $ref links of policies assigned to {servicePrincipal}.
        slots:
          servicePrincipal: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/claimsMappingPolicies/$ref'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a claims mapping policy to a service principal
      effect: write
      questions:
      - How do I assign a claims mapping policy to an enterprise app?
      - What reference do I pass to attach a claims mapping policy to a service principal?
      instructions:
      - text: Assign claims mapping policy {policyRef} to service principal {servicePrincipal}.
        slots:
          policyRef: requestBody.@odata.id
          servicePrincipal: path.servicePrincipal-id
      - text: Attach a claims mapping policy to app {servicePrincipal}.
        slots:
          servicePrincipal: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/servicePrincipals/{servicePrincipal-id}/claimsMappingPolicies/$ref'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unassign a claims mapping policy by reference
      effect: destructive
      questions:
      - Can I remove a claims mapping policy by passing its @id reference as a query parameter?
      - How do I detach a policy from a service principal when I only have its reference URL?
      instructions:
      - text: Remove the claims mapping policy referenced by {ref} from service principal {servicePrincipal}.
        slots:
          ref: query.@id
          servicePrincipal: path.servicePrincipal-id
      - text: Detach policy reference {ref} from app {servicePrincipal}.
        slots:
          ref: query.@id
          servicePrincipal: path.servicePrincipal-id
      method: generated
      generated: '2026-10-01'