Microsoft Endpoint Configuration Management User Device Associations API

openapi: 3.2.0
info:
  title: Microsoft Endpoint Configuration Management Intune Data Warehouse User Device Associations API
  description: OData-based REST API that provides access to Intune reporting data in a machine-readable format. Enables building custom reports and analytics for enterprise mobile environment insights. Uses OData v4.0 protocol with standard patterns for request/response headers, status codes, HTTP methods, URL conventions, and query options. Data is sampled daily to provide a historical view of the mobile device environment.
  version: 1.0.0
  contact:
    name: Microsoft Intune Support
    url: https://learn.microsoft.com/en-us/intune/intune-service/developer/reports-nav-intune-data-warehouse
  license:
    name: Microsoft API License
    url: https://learn.microsoft.com/en-us/legal/microsoft-apis/terms-of-use
servers:
- url: https://fef.{location}.manage.microsoft.com/ReportingService/DataWarehouseFEService
  description: Intune Data Warehouse endpoint
  variables:
    location:
      default: msua06
      description: Location identifier found in the Data Warehouse API blade in the Microsoft Intune admin center.
security:
- oauth2: []
tags:
- name: User Device Associations
  description: User-to-device mapping records.
paths:
  /userDeviceAssociations:
    get:
      operationId: listUserDeviceAssociations
      summary: Microsoft Endpoint Configuration Management List user-device associations
      description: Retrieve records mapping users to their associated devices.
      tags:
      - User Device Associations
      parameters:
      - $ref: '#/components/parameters/apiVersion'
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/skip'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/select'
      - $ref: '#/components/parameters/maxhistorydays'
      responses:
        '200':
          description: Successful response returning user-device associations.
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserDeviceAssociation'
components:
  parameters:
    maxhistorydays:
      name: maxhistorydays
      in: query
      description: Maximum number of days of history to retrieve. Only takes effect for collections that include dateKey as part of their key property.
      schema:
        type: integer
        default: 7
    apiVersion:
      name: api-version
      in: query
      required: true
      description: API version. Use 'v1.0' for stable or 'beta' for preview features.
      schema:
        type: string
        enum:
        - v1.0
        - beta
        default: v1.0
    select:
      name: $select
      in: query
      description: Comma-separated list of properties to include.
      schema:
        type: string
    top:
      name: $top
      in: query
      description: Number of items to return.
      schema:
        type: integer
    skip:
      name: $skip
      in: query
      description: Number of items to skip.
      schema:
        type: integer
    filter:
      name: $filter
      in: query
      description: OData filter expression. Only DateKey or RowLastModifiedDateTimeUTC may be supported for filtering depending on the collection.
      schema:
        type: string
  schemas:
    UserDeviceAssociation:
      type: object
      description: Record mapping a user to an associated device.
      properties:
        userDeviceAssociationKey:
          type: integer
          description: Unique key for the association.
        userKey:
          type: integer
          description: User key reference.
        deviceKey:
          type: integer
          description: Device key reference.
        createdDate:
          type: string
          format: date-time
          description: Date the association was created.
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 via Microsoft Entra ID. Requires Intune service administrator role or role-based access to the Intune data warehouse resource.
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes:
            https://api.manage.microsoft.com/.default: Access Intune Data Warehouse