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

API Evangelist conversational phrasing for Users.license Details API

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

$.info
$.paths['/users/{user-id}/licenseDetails'].get
$.paths['/users/{user-id}/licenseDetails'].post
$.paths['/users/{user-id}/licenseDetails/{licenseDetails-id}'].get
$.paths['/users/{user-id}/licenseDetails/{licenseDetails-id}'].delete
$.paths['/users/{user-id}/licenseDetails/{licenseDetails-id}'].patch
$.paths['/users/{user-id}/licenseDetails/$count'].get
$.paths['/users/{user-id}/licenseDetails/microsoft.graph.getTeamsLicensingDetails()'].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 Users.license Details API
  version: 1.0.0
extends: openapi/azure-ad-users-licensedetails-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: 7
- target: $.paths['/users/{user-id}/licenseDetails'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's license details
      effect: read
      questions:
      - Which licenses and service plans does a user have?
      - What SKUs is a particular employee licensed for?
      instructions:
      - text: List the license details for user {user_id}.
        slots:
          user_id: path.user-id
      - text: Show every SKU and service plan assigned to {user_id}.
        slots:
          user_id: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/licenseDetails'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a license detail record to a user
      effect: write
      questions:
      - Can I create a licenseDetails entry on a user through this endpoint?
      - Is there a way to write a new license detail record for a user?
      instructions:
      - text: Create a license detail record for user {user_id} with SKU {sku_id}.
        slots:
          user_id: path.user-id
          sku_id: requestBody.skuId
      - text: Add license detail with SKU part number {sku_part} to user {user_id}.
        slots:
          sku_part: requestBody.skuPartNumber
          user_id: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/licenseDetails/{licenseDetails-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one license detail of a user
      effect: read
      questions:
      - Which service plans are included in one specific license a user holds?
      - Can I read a single license detail record for a user?
      instructions:
      - text: Get license detail {license_id} of user {user_id}.
        slots:
          license_id: path.licenseDetails-id
          user_id: path.user-id
      - text: Show the service plans in license {license_id} assigned to {user_id}.
        slots:
          license_id: path.licenseDetails-id
          user_id: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/licenseDetails/{licenseDetails-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a license detail record from a user
      effect: destructive
      questions:
      - Can I delete a licenseDetails record from a user?
      - What happens when a license detail entry is removed from a user?
      instructions:
      - text: Delete license detail {license_id} from user {user_id}.
        slots:
          license_id: path.licenseDetails-id
          user_id: path.user-id
      - text: Remove the license detail record {license_id} on {user_id}.
        slots:
          license_id: path.licenseDetails-id
          user_id: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/licenseDetails/{licenseDetails-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a license detail record on a user
      effect: write
      questions:
      - Can I change the service plans recorded on a user's existing license detail?
      - Is a user's license detail record editable?
      instructions:
      - text: Update license detail {license_id} of user {user_id}.
        slots:
          license_id: path.licenseDetails-id
          user_id: path.user-id
      - text: Set the service plans on license detail {license_id} for {user_id} to {plans}.
        slots:
          license_id: path.licenseDetails-id
          user_id: path.user-id
          plans: requestBody.servicePlans
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/licenseDetails/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a user's licenses
      effect: read
      questions:
      - How many licenses does a user have?
      - Is this user licensed for anything at all?
      instructions:
      - text: Count the license details for user {user_id}.
        slots:
          user_id: path.user-id
      - text: Tell me how many licenses {user_id} holds.
        slots:
          user_id: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/licenseDetails/microsoft.graph.getTeamsLicensingDetails()'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a user's Microsoft Teams license status
      effect: read
      questions:
      - Does a user have a Teams license?
      - What's the Microsoft Teams licensing status of a specific person?
      instructions:
      - text: Get the Teams licensing details for user {user_id}.
        slots:
          user_id: path.user-id
      - text: Check whether {user_id} is licensed for Microsoft Teams.
        slots:
          user_id: path.user-id
      method: generated
      generated: '2026-10-01'