---
title: "List user profiles"
method: GET
path: "/user-profiles"
tags: ["Configuration - Policy"]
---

# List user profiles

`GET /user-profiles`

List a page of user profiles.

## Query parameters

- `page` integer
- `limit` integer

## Response `200`

OK

- PagedXiqUserProfile
  - `page` integer, required — The current page number
  - `count` integer, required — The element count of the current page
  - `total_pages` integer, required — The total page number based on request page size
  - `total_count` integer, required — The total element count
  - `data` XiqUserProfile[] — The data in the current page
    - `id` integer, required — The unique identifier
    - `create_time` string, date-time, required — The create time in UTC (ISO 8601 format)
    - `update_time` string, date-time, required — The last update time in UTC (ISO 8601 format)
    - `name` string, required — The user profile name
    - `vlan_profile` XiqVlanProfile — The payload of common object - VLAN profile
      - `id` integer, required — The unique identifier
      - `create_time` string, date-time, required — The create time in UTC (ISO 8601 format)
      - `update_time` string, date-time, required — The last update time in UTC (ISO 8601 format)
      - `org_id` integer — The organization identifier, valid when enabling HIQ feature
      - `name` string, required — The VLAN profile name
      - `default_vlan_id` integer, required — The default VLAN ID
      - `enable_classification` boolean, required — If apply VLANs to devices using classification
      - `classified_entries` XiqVlanObjectClassifiedEntry[] — The VLAN object classified entries
        - `id` integer, required — The unique identifier
        - `create_time` string, date-time, required — The create time in UTC (ISO 8601 format)
        - `update_time` string, date-time, required — The last update time in UTC (ISO 8601 format)
        - `org_id` integer — The organization identifier, valid when enabling HIQ feature
        - `vlan_id` integer, required — The VLAN ID
        - `classification_rule` XiqClassificationRule — The payload of common object - classification assignment
          - `id` integer, required — The unique identifier
          - `create_time` string, date-time, required — The create time in UTC (ISO 8601 format)
          - `update_time` string, date-time, required — The last update time in UTC (ISO 8601 format)
          - `org_id` integer — The organization identifier, valid when enabling HIQ feature
          - `name` string, required — The classification assignment name
          - `description` string — The classification assignment description
          - `classifications` XiqClassification[] — The details of rule assignments
            - `id` integer, required — The unique identifier
            - `create_time` string, date-time, required — The create time in UTC (ISO 8601 format)
            - `update_time` string, date-time, required — The last update time in UTC (ISO 8601 format)
            - `classification_type` 'LOCATION' | 'CLOUD_CONFIG_GROUP' | 'IP_ADDRESS' | 'IP_SUBNET' | 'IP_RANGE', required — The classification type for VLAN assignment. LOCATION: Classify based on device location (e.g., floor, building). CLOUD_CONFIG_GROUP: Classify based on cloud configuration groups. IP_ADDRESS: Classify based on specific IP addresses. IP_SUBNET: Classify based on IP subnet ranges (e.g., 192.168.1.0/24). IP_RANGE: Classify based on IP address ranges (e.g., 192.168.1.1-192.168.1.100).
            - `match` boolean, required — Contains or not contains)
            - `classification_id` integer, required — The ID of location, cloud config group, IP address, IP subnet or IP range.
            - `value` string, required — The MAC address in format 'AABBCCDDEEFF' without separators. Accepted formats: (1) OUI only — first 6 hex characters (e.g., 'AABBCC'), (2) Full MAC address — 12 hex characters (e.g., 'AABBCCDDEEFF').

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)