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

API Evangelist conversational phrasing for Users.extension API

7 actions 7 updates phrasing extends openapi/azure-ad-users-extension-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['/users/{user-id}/extensions'].get

$.paths['/users/{user-id}/extensions'].post

$.paths['/users/{user-id}/extensions/{extension-id}'].get

$.paths['/users/{user-id}/extensions/{extension-id}'].delete

$.paths['/users/{user-id}/extensions/{extension-id}'].patch

$.paths['/users/{user-id}/extensions/$count'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Users.extension API
  version: 1.0.0
extends: openapi/azure-ad-users-extension-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['/users/{user-id}/extensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List open extensions on a user
      effect: read
      questions:
      - What custom open extensions have been stored on a user's profile?
      - Can I page through a user's open extensions?
      instructions:
      - text: List the open extensions on user {user}.
        slots:
          user: path.user-id
      - text: Show the first {top} extensions stored for user {user}.
        slots:
          user: path.user-id
          top: query.$top
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/extensions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an open extension to a user
      effect: write
      questions:
      - How do I attach custom data to a user with an open extension?
      - Can I store app-specific properties on a user account?
      instructions:
      - text: Create an open extension on user {user}.
        slots:
          user: path.user-id
      - text: Add a custom open extension with id {id} to user {user}.
        slots:
          id: requestBody.id
          user: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/extensions/{extension-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one open extension on a user
      effect: read
      questions:
      - How do I read a specific custom extension stored on a user?
      - What data does a single user open extension hold?
      instructions:
      - text: Get extension {extension} on user {user}.
        slots:
          extension: path.extension-id
          user: path.user-id
      - text: Show the custom data in open extension {extension} for user {user}.
        slots:
          extension: path.extension-id
          user: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/extensions/{extension-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an open extension from a user
      effect: destructive
      questions:
      - Can I remove custom data I stored on a user as an open extension?
      - Does deleting a user extension support an ETag check?
      instructions:
      - text: Delete extension {extension} from user {user}.
        slots:
          extension: path.extension-id
          user: path.user-id
      - text: Remove open extension {extension} on user {user} if its ETag is {etag}.
        slots:
          extension: path.extension-id
          user: path.user-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/extensions/{extension-id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an open extension on a user
      effect: write
      questions:
      - Can I change the custom values in a user's existing open extension?
      - Is it possible to patch an open extension already on a user?
      instructions:
      - text: Update extension {extension} on user {user}.
        slots:
          extension: path.extension-id
          user: path.user-id
      - text: Edit the custom data of existing open extension {extension} for user {user}.
        slots:
          extension: path.extension-id
          user: path.user-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{user-id}/extensions/$count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count open extensions on a user
      effect: read
      questions:
      - How many open extensions does a user have?
      - Can I count a user's extensions that match a filter?
      instructions:
      - text: Count the open extensions on user {user}.
        slots:
          user: path.user-id
      - text: Give me the number of extensions on user {user} matching {filter}.
        slots:
          user: path.user-id
          filter: query.$filter
      method: generated
      generated: '2026-10-01'