Microsoft Entra ID (formerly Azure AD)

Microsoft Entra ID (formerly Azure AD) Groups.profile Photo API

The groups.profilePhoto API from Microsoft Entra ID (formerly Azure AD) — 5 operation(s) for groups.profilephoto.

GitHub OpenAPI

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /groups/{group-id}/photo Get metadata for a group's main profile photo · Get photo from groups #
Ask an LLM
“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?”
Tell an agent
Get the main profile photo metadata for group {group_id}.
Show the height and width of {group_id}'s current group picture.
PATCH /groups/{group-id}/photo Update a group's profile photo metadata · Update the navigation property photo in groups #
Ask an LLM
“Can I patch the height and width recorded on a group's profile photo?”
“Which metadata fields of a group photo are updatable?”
Tell an agent
Update the profile photo metadata on group {group_id} to height {height} and width {width}.
Patch the photo properties for group {group_id}.
DELETE /groups/{group-id}/photo Delete a group's profile photo object · Delete navigation property photo for groups #
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Delete the profile photo object from group {group_id}.
Remove group {group_id}'s photo navigation property, matching ETag {etag}.
GET /groups/{group-id}/photo/$value Download a group's current profile picture · Get media content for the navigation property photo from groups #
Ask an LLM
“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?”
Tell an agent
Download the profile picture image for group {group_id}.
Fetch the binary content of {group_id}'s main photo.
PUT /groups/{group-id}/photo/$value Upload a new profile picture for a group · Update media content for the navigation property photo in groups #
Ask an LLM
“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?”
Tell an agent
Upload a new profile picture for group {group_id}.
Replace the main photo image on {group_id} with this file.
DELETE /groups/{group-id}/photo/$value Remove a group's profile picture image · Delete media content for the navigation property photo in groups #
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Delete the profile picture image from group {group_id}.
Clear the main photo content for {group_id}.
GET /groups/{group-id}/photos List all photo sizes a group owns · List photos #
Ask an LLM
“Which photo sizes are available for a group's profile picture?”
“Can I list every profilePhoto object owned by a group?”
Tell an agent
List all profile photos owned by group {group_id}.
Show the available photo sizes for {group_id}.
GET /groups/{group-id}/photos/{profilePhoto-id} Get details of one photo size for a group · Get photos from groups #
Ask an LLM
“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?”
Tell an agent
Get the metadata for photo size {photo_id} of group {group_id}.
Show only {fields} for sized photo {photo_id} in {group_id}'s photo collection.
GET /groups/{group-id}/photos/{profilePhoto-id}/$value Download a specific photo size for a group · List photos #
Ask an LLM
“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?”
Tell an agent
Download image {photo_id} from group {group_id}'s photos collection.
Fetch the {photo_id} thumbnail bytes for {group_id}.
PUT /groups/{group-id}/photos/{profilePhoto-id}/$value Upload image content for one group photo size · Update media content for the navigation property photos in groups #
Ask an LLM
“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?”
Tell an agent
Upload the image for photo size {photo_id} on group {group_id}.
Replace sized photo {photo_id} content in {group_id}'s collection.
DELETE /groups/{group-id}/photos/{profilePhoto-id}/$value Remove image content for one group photo size · Delete media content for the navigation property photos in groups #
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Delete the image content of photo size {photo_id} on group {group_id}.
Clear sized photo {photo_id} bytes from {group_id}'s collection.

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/graph/api/overview
📖
Authentication
https://learn.microsoft.com/en-us/graph/auth/
📖
Documentation
https://learn.microsoft.com/en-us/graph/change-notifications-overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/azure-ad/refs/heads/main/openapi/azure-ad-groups-profilephoto-api-openapi.yml

Other Resources

🔗
SDKs
https://learn.microsoft.com/en-us/graph/sdks/sdks-overview
🔗
ChangeLog
https://developer.microsoft.com/en-us/graph/changelog
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/azure-ad/refs/heads/main/asyncapi/azure-ad-change-notifications-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/azure-ad:azure-ad-groups-profilephoto-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

azure-ad-groups-profilephoto-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Groups.profile Photo API
  version: v1.0
servers:
- url: https://graph.microsoft.com/v1.0/
  description: Core
security:
- azureaadv2: []
tags:
- name: groups.profilePhoto
paths:
  /groups/{group-id}/photo:
    get:
      tags:
      - groups.profilePhoto
      summary: Get photo from groups
      description: The group's profile photo
      operationId: group_GetPhoto
      parameters:
      - name: group-id
        in: path
        description: The unique identifier of group
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: group
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          description: Retrieved navigation property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.profilePhoto'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    patch:
      tags:
      - groups.profilePhoto
      summary: Update the navigation property photo in groups
      operationId: group_UpdatePhoto
      parameters:
      - name: group-id
        in: path
        description: The unique identifier of group
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: group
      requestBody:
        description: New navigation property values
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/microsoft.graph.profilePhoto'
        required: true
      responses:
        2XX:
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.profilePhoto'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
    delete:
      tags:
      - groups.profilePhoto
      summary: Delete navigation property photo for groups
      operationId: group_DeletePhoto
      parameters:
      - name: group-id
        in: path
        description: The unique identifier of group
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: group
      - name: If-Match
        in: header
        description: ETag
        style: simple
        schema:
          type: string
      responses:
        2XX:
          description: Success
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
  /groups/{group-id}/photo/$value:
    get:
      tags:
      - groups.profilePhoto
      summary: Get media content for the navigation property photo from groups
      description: The group's profile photo
      operationId: group_GetPhotoContent
      parameters:
      - name: group-id
        in: path
        description: The unique identifier of group
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: group
      responses:
        2XX:
          description: Retrieved media content
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        default:
          $ref: '#/components/responses/error'
    put:
      tags:
      - groups.profilePhoto
      summary: Update media content for the navigation property photo in groups
      description: The group's profile photo
      operationId: group_SetPhotoContent
      parameters:
      - name: group-id
        in: path
        description: The unique identifier of group
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: group
      requestBody:
        description: New media content.
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
        required: true
      responses:
        2XX:
          description: Success
        default:
          $ref: '#/components/responses/error'
    delete:
      tags:
      - groups.profilePhoto
      summary: Delete media content for the navigation property photo in groups
      description: The group's profile photo
      operationId: group_DeletePhotoContent
      parameters:
      - name: group-id
        in: path
        description: The unique identifier of group
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: group
      - name: If-Match
        in: header
        description: ETag
        style: simple
        schema:
          type: string
      responses:
        2XX:
          description: Success
        default:
          $ref: '#/components/responses/error'
  /groups/{group-id}/photos:
    get:
      tags:
      - groups.profilePhoto
      summary: List photos
      description: Retrieve a list of profilePhoto objects.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/group-list-photos?view=graph-rest-1.0
      operationId: group_ListPhoto
      parameters:
      - name: group-id
        in: path
        description: The unique identifier of group
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: group
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/search'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/count'
      - name: $orderby
        in: query
        description: Order items by property values
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          $ref: '#/components/responses/microsoft.graph.profilePhotoCollectionResponse'
        default:
          $ref: '#/components/responses/error'
      x-ms-pageable:
        nextLinkName: '@odata.nextLink'
        operationName: listMore
      x-ms-docs-operation-type: operation
  /groups/{group-id}/photos/{profilePhoto-id}:
    get:
      tags:
      - groups.profilePhoto
      summary: Get photos from groups
      description: The profile photos owned by the group. Read-only. Nullable.
      operationId: getGroupsByGroupIdPhotosByProfilePhotoId
      parameters:
      - name: group-id
        in: path
        description: The unique identifier of group
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: group
      - name: profilePhoto-id
        in: path
        description: The unique identifier of profilePhoto
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: profilePhoto
      - name: $select
        in: query
        description: Select properties to be returned
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      - name: $expand
        in: query
        description: Expand related entities
        style: form
        explode: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
      responses:
        2XX:
          description: Retrieved navigation property
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/microsoft.graph.profilePhoto'
        default:
          $ref: '#/components/responses/error'
      x-ms-docs-operation-type: operation
      x-operation-id-source: normalized
      x-operation-id-original: group_GetPhoto
  /groups/{group-id}/photos/{profilePhoto-id}/$value:
    get:
      tags:
      - groups.profilePhoto
      summary: List photos
      description: Retrieve a list of profilePhoto objects.
      externalDocs:
        description: Find more info here
        url: https://learn.microsoft.com/graph/api/group-list-photos?view=graph-rest-1.0
      operationId: group_GetPhotosContent
      parameters:
      - name: group-id
        in: path
        description: The unique identifier of group
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: group
      - name: profilePhoto-id
        in: path
        description: The unique identifier of profilePhoto
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: profilePhoto
      responses:
        2XX:
          description: Retrieved media content
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        default:
          $ref: '#/components/responses/error'
    put:
      tags:
      - groups.profilePhoto
      summary: Update media content for the navigation property photos in groups
      description: The unique identifier for an entity. Read-only.
      operationId: group_SetPhotosContent
      parameters:
      - name: group-id
        in: path
        description: The unique identifier of group
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: group
      - name: profilePhoto-id
        in: path
        description: The unique identifier of profilePhoto
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: profilePhoto
      requestBody:
        description: New media content.
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
        required: true
      responses:
        2XX:
          description: Success
        default:
          $ref: '#/components/responses/error'
    delete:
      tags:
      - groups.profilePhoto
      summary: Delete media content for the navigation property photos in groups
      description: The unique identifier for an entity. Read-only.
      operationId: group_DeletePhotosContent
      parameters:
      - name: group-id
        in: path
        description: The unique identifier of group
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: group
      - name: profilePhoto-id
        in: path
        description: The unique identifier of profilePhoto
        required: true
        style: simple
        schema:
          type: string
        x-ms-docs-key-type: profilePhoto
      - name: If-Match
        in: header
        description: ETag
        style: simple
        schema:
          type: string
      responses:
        2XX:
          description: Success
        default:
          $ref: '#/components/responses/error'
components:
  parameters:
    count:
      name: $count
      in: query
      description: Include count of items
      style: form
      explode: false
      schema:
        type: boolean
    search:
      name: $search
      in: query
      description: Search items by search phrases
      style: form
      explode: false
      schema:
        type: string
    top:
      name: $top
      in: query
      description: Show only the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
      example: 50
    skip:
      name: $skip
      in: query
      description: Skip the first n items
      style: form
      explode: false
      schema:
        minimum: 0
        type: integer
    filter:
      name: $filter
      in: query
      description: Filter items by property values
      style: form
      explode: false
      schema:
        type: string
  schemas:
    microsoft.graph.entity:
      title: entity
      type: object
      properties:
        id:
          type: string
          description: The unique identifier for an entity. Read-only.
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.InnerError:
      type: object
      additionalProperties:
        type: object
      description: The structure of this object is service-specific
    microsoft.graph.ODataErrors.ODataError:
      required:
      - error
      type: object
      properties:
        error:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.MainError'
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.MainError:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
          x-ms-primary-error-message: true
        target:
          type:
          - string
          - 'null'
        details:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ErrorDetails'
        innerError:
          $ref: '#/components/schemas/microsoft.graph.ODataErrors.InnerError'
      additionalProperties:
        type: object
    microsoft.graph.profilePhoto:
      allOf:
      - $ref: '#/components/schemas/microsoft.graph.entity'
      - title: profilePhoto
        type: object
        properties:
          height:
            maximum: 2147483647
            minimum: -2147483648
            type:
            - number
            - 'null'
            description: The height of the photo. Read-only.
            format: int32
          width:
            maximum: 2147483647
            minimum: -2147483648
            type:
            - number
            - 'null'
            description: The width of the photo. Read-only.
            format: int32
        additionalProperties:
          type: object
    microsoft.graph.profilePhotoCollectionResponse:
      title: Collection of profilePhoto
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/microsoft.graph.profilePhoto'
        '@odata.nextLink':
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
    microsoft.graph.ODataErrors.ErrorDetails:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        target:
          type:
          - string
          - 'null'
      additionalProperties:
        type: object
  responses:
    error:
      description: error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.ODataErrors.ODataError'
    microsoft.graph.profilePhotoCollectionResponse:
      description: Retrieved collection
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/microsoft.graph.profilePhotoCollectionResponse'
  securitySchemes:
    azureaadv2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes: {}