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

API Evangelist conversational phrasing for Groups.profile Photo API

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

$.info

$.paths['/groups/{group-id}/photo'].get

$.paths['/groups/{group-id}/photo'].delete

$.paths['/groups/{group-id}/photo'].patch

$.paths['/groups/{group-id}/photo/$value'].get

$.paths['/groups/{group-id}/photo/$value'].put

$.paths['/groups/{group-id}/photo/$value'].delete

$.paths['/groups/{group-id}/photos'].get

$.paths['/groups/{group-id}/photos/{profilePhoto-id}'].get

$.paths['/groups/{group-id}/photos/{profilePhoto-id}/$value'].get

$.paths['/groups/{group-id}/photos/{profilePhoto-id}/$value'].put

$.paths['/groups/{group-id}/photos/{profilePhoto-id}/$value'].delete

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 Groups.profile Photo API
  version: 1.0.0
extends: openapi/azure-ad-groups-profilephoto-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: 11
- target: $.paths['/groups/{group-id}/photo'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metadata for a group's main profile photo
      effect: read
      questions:
      - What are the dimensions of a group's current profile picture?
      - Can I check whether a group has a main photo set before downloading it?
      instructions:
      - text: Get the main profile photo metadata for group {group_id}.
        slots:
          group_id: path.group-id
      - text: Show the height and width of {group_id}'s current group picture.
        slots:
          group_id: path.group-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/photo'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a group's profile photo object
      effect: destructive
      questions:
      - Can I delete the photo navigation property on a group entirely?
      - What is the difference between removing the photo object and removing just its image bytes?
      instructions:
      - text: Delete the profile photo object from group {group_id}.
        slots:
          group_id: path.group-id
      - text: Remove group {group_id}'s photo navigation property, matching ETag {etag}.
        slots:
          group_id: path.group-id
          etag: header.If-Match
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/photo'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a group's profile photo metadata
      effect: write
      questions:
      - Can I patch the height and width recorded on a group's profile photo?
      - Which metadata fields of a group photo are updatable?
      instructions:
      - text: Update the profile photo metadata on group {group_id} to height {height} and width {width}.
        slots:
          group_id: path.group-id
          height: requestBody.height
          width: requestBody.width
      - text: Patch the photo properties for group {group_id}.
        slots:
          group_id: path.group-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/photo/$value'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a group's current profile picture
      effect: read
      questions:
      - How do I download the actual image file of a group's profile picture?
      - Can I get the raw bytes of a group's main photo to display in my app?
      instructions:
      - text: Download the profile picture image for group {group_id}.
        slots:
          group_id: path.group-id
      - text: Fetch the binary content of {group_id}'s main photo.
        slots:
          group_id: path.group-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/photo/$value'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload a new profile picture for a group
      effect: write
      questions:
      - How do I upload or replace the profile picture on a Microsoft 365 group?
      - Can I set a team's group photo by sending the image bytes?
      instructions:
      - text: Upload a new profile picture for group {group_id}.
        slots:
          group_id: path.group-id
      - text: Replace the main photo image on {group_id} with this file.
        slots:
          group_id: path.group-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/photo/$value'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a group's profile picture image
      effect: destructive
      questions:
      - How can I clear the picture on a group so it falls back to the default?
      - Can I delete only the image bytes of a group's main photo?
      instructions:
      - text: Delete the profile picture image from group {group_id}.
        slots:
          group_id: path.group-id
      - text: Clear the main photo content for {group_id}.
        slots:
          group_id: path.group-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/photos'].get
  update:
    x-apievangelist-phrasing:
      intent: List all photo sizes a group owns
      effect: read
      questions:
      - Which photo sizes are available for a group's profile picture?
      - Can I list every profilePhoto object owned by a group?
      instructions:
      - text: List all profile photos owned by group {group_id}.
        slots:
          group_id: path.group-id
      - text: Show the available photo sizes for {group_id}.
        slots:
          group_id: path.group-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/photos/{profilePhoto-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one photo size for a group
      effect: read
      questions:
      - What are the pixel dimensions of one particular photo size in a group's collection?
      - Can I read the metadata of a single sized group photo without downloading the image?
      instructions:
      - text: Get the metadata for photo size {photo_id} of group {group_id}.
        slots:
          photo_id: path.profilePhoto-id
          group_id: path.group-id
      - text: Show only {fields} for sized photo {photo_id} in {group_id}'s photo collection.
        slots:
          fields: query.$select
          photo_id: path.profilePhoto-id
          group_id: path.group-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/photos/{profilePhoto-id}/$value'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a specific photo size for a group
      effect: read
      questions:
      - How do I download a group's picture at a specific size like a thumbnail?
      - Can I fetch the image bytes of one sized photo in a group's collection?
      instructions:
      - text: Download image {photo_id} from group {group_id}'s photos collection.
        slots:
          photo_id: path.profilePhoto-id
          group_id: path.group-id
      - text: Fetch the {photo_id} thumbnail bytes for {group_id}.
        slots:
          photo_id: path.profilePhoto-id
          group_id: path.group-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/photos/{profilePhoto-id}/$value'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload image content for one group photo size
      effect: write
      questions:
      - Can I upload the image for one specific size in a group's photos collection?
      - Is it possible to replace only a single sized photo of a group?
      instructions:
      - text: Upload the image for photo size {photo_id} on group {group_id}.
        slots:
          photo_id: path.profilePhoto-id
          group_id: path.group-id
      - text: Replace sized photo {photo_id} content in {group_id}'s collection.
        slots:
          photo_id: path.profilePhoto-id
          group_id: path.group-id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{group-id}/photos/{profilePhoto-id}/$value'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove image content for one group photo size
      effect: destructive
      questions:
      - Can I delete the image bytes for just one size in a group's photos collection?
      - What removes a single sized photo without touching the group's main picture?
      instructions:
      - text: Delete the image content of photo size {photo_id} on group {group_id}.
        slots:
          photo_id: path.profilePhoto-id
          group_id: path.group-id
      - text: Clear sized photo {photo_id} bytes from {group_id}'s collection.
        slots:
          photo_id: path.profilePhoto-id
          group_id: path.group-id
      method: generated
      generated: '2026-10-01'