--- title: "List SSIDs" method: GET path: "/ssids" tags: ["Configuration - Policy"] --- # List SSIDs `GET /ssids` List SSIDs with filter and pagination. ## Query parameters - `page` integer - `limit` integer ## Response `200` OK - PagedXiqSsid - `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` XiqSsid[] — 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) - `org_id` integer — The organization identifier, valid when enabling HIQ feature - `name` string, required — The SSID profile name - `broadcast_name` string, required — The SSID broadcast name - `description` string — The SSID description - `predefined` boolean, required — Whether it is predefined - `advanced_settings_id` integer — The SSID advanced settings ID. - `enable_user_profile_assignment` boolean — The flag to enable User Profile Assignment. - `enable_radius_attribute_user_profile_assignment` boolean — The flag to enable Radius Attribute User Profile Assignment. - `attribute_type` 'TUNNEL' | 'STANDARD' | 'CUSTOM' — The attribute type name - `attribute_key` integer — The SSID attribute key. - `access_security` XiqSsidAccessSecurity — The SSID access security. - `key_type` 'ASCII' | 'HEX' — The key type, ASCII or HEX - `key_value` string — The schedule type name. - `sae_group` 'ALL' | 'ECC' | 'FFC' — The SAE group: ALL, ECC, or FFC, must be selected when the key management is WPA3 - `anti_logging_threshold` integer — The anti-logging threshold value representing the maximum number of failed authentication attempts before triggering anti-logging protection. - `transition_mode` boolean — The flag for enabling transition mode. - `security_type` string — The security type. - `key_management` 'WPA_PSK' | 'WPA2_PSK' | 'WPA3_PSK' | 'AUTO_PSK' | 'WPA_8021X' | 'WPA2_8021X' | 'WPA3_8021X' | 'AUTO_8021X' | 'WEP' | 'WEP_8021' — The SSID key management value. - `encryption_method` 'CCMP' | 'TKIP' | 'AUTO_TKIP_CCMP' | 'WEP40' | 'WEP104' | 'AES192' — The SSID encryption method. - `radius_client_profile` XiqRadiusClientProfile — The RADIUS client profile. - `default_radius_client_object_id` integer — The default RADIUS client object ID. - `enable_classification` boolean — The flag to enable classification entries on RADIUS client profile. - `classified_entries` XiqRadiusClientProfileEntry[] — The RADIUS client profile classified entries. - `classification_assignment_id` integer — The classification assignment ID for RADIUS client profile entry. - `radius_client_object_id` integer — The RADIUS client object ID for RADIUS client profile entry. - `default_user_profile` integer — The default User Profile ID. - `vendor_id` integer — The vendor id, when the Attribute type is CUSTOM. - `user_profile_assignment_rules` XiqUserProfileAssignmentRule[] — The SSID user profile assignment rules. - `user_profile` XiqUserProfile — The payload of User 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) - `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 - … - `user_profile_assignment` XiqUserProfileAssignment — The payload of User Profile 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 — The user profile name - `description` string — The user profile assignment description - `authorisation_policy` string — The Authorization policy name - `folder_ids` integer[] — The location folder Id list - `assignment_radius_attribute` XiqUserProfileAssignmentRadiusAttribute — The User Profile Assignment Radius Attribute. - `attribute_type` 'TUNNEL' | 'STANDARD' | 'CUSTOM' — The attribute type name - `attribute_values` string — The Attribute type value - `user_group` XiqUserGroup[] — The set of User groups. - `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 user group name - `description` string — The user group description - `predefined` boolean, required — Whether it is predefined - `password_db_location` 'CLOUD' | 'LOCAL', required — The access key storage location - `password_type` 'PPSK' | 'RADIUS', required — The access key type - `pcg_use_only` boolean — Whether it's for PCG use only - `pcg_type` 'AP_BASED' | 'KEY_BASED' — The private client group type for pcgUseOnly - `ppsk_use_only` boolean — Whether it's for PPSK use only - `enable_cwp_reg` boolean — Whether to enable CWP registration setting - `password_settings` XiqPasswordSettings, required — The password settings ID - `enable_letters` boolean — Enable use of letters - `enable_numbers` boolean — Enable use of numbers - `enable_special_characters` boolean — Enable use of special characters - `password_concat_string` string — The password concatenated string - `psk_generation_method` 'PASSWORD_ONLY' | 'USER_STRING_PASSWORD', required — The psk generation method - `password_character_types` 'INCLUDE_ALL_CHARACTER_TYPE_ENABLED' | 'INCLUDE_ANY_CHARACTER_TYPES_ENABLED' | 'INCLUDE_ONLY_ONE_CHARACTER_TYPE_ENABLED', required — Password generation using letters, numbers, and/or special characters - `password_length` integer, required — The maximun password string length - `expiration_settings` XiqExpirationSettings, required — The password expiration settings - `expiration_type` 'NEVER_EXPIRE' | 'VALID_DURING_DATES' | 'VALID_FOR_TIME_PERIOD' | 'DAILY' — The for one of the account experation types. - `valid_during_dates` XiqValidDuringDateSettings — The settings for Valid During Dates option or null for other settings. - … - `valid_for_time_period` XiqValidForTimePeriodSettings — The settings for Valid For Time Period option or null for other settings. - … - `valid_daily` XiqValidDailySettings — The settings for Valid Daily option or null for other settings. - … - `expiration_action` 'SHOW_MESSAGE' | 'REJECT_ACCESS' — The Expiration Action to take, null if the account is never expired. - `post_expiration_action` XiqPostExpirationAction — The type of action to take after the account expiration. - … - `delivery_settings` XiqDeliverySettings, required — The password delivery settings - `email_template_id` integer — The Email Template ID - `sms_template_id` integer — The SMS Template ID - `user_count` integer, required — The user count - `ssids` string[], required — The ssids - `mac_object_profiles` XiqMacObject[] — The set of Mac object profiles. - `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 — The MAC object name - `description` string — The MAC object description. - `predefined` boolean — Whether the MAC Oui is predefined - `value` string — The MAC octets in hexadecimal format without separators. For MAC_OUI: 6 characters (e.g., '001DA2'). For MAC_ADDRESS or MAC_RANGE: 12 characters (e.g., 'AABBCCDDEEFF'). - `mac_type` 'MAC_OUI' | 'MAC_RANGE' | 'MAC_ADDRESS' — The MAC object type e.g, "MAC_OUI", "MAC_RANGE" or "MAC_ADDRESS" - `defender_defined` boolean — Whether defender is defined - `mac_address_end` string — The MAC address end in hexadecimal format without separators (12 characters), only available for "MAC_RANGE". - `os_object_dhcp` XiqOsObject[] — The set of OS DHCP objects. - `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 — The OS object name. - `os_object_https` XiqOsObject[] — The set of OS HTTP objects. - `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 — The OS object name. - `schedules` XiqSchedule[] — The set of OS HTTP objects. - `description` string — Schedule description. - `schedule_type` 'ONE_TIME' | 'RECURRING' — Schedule type e.g ONE_TYPE or RECURRING . - `start_date` string, date — The start date of the schedule. - `end_date` string, date — The end date of the schedule. - `start_time` string, time — The start time of the schedule. - `end_time` string, time — The end time of the schedule. - `recurrence_type` 'EVERYDAY' | 'WEEKDAY_RANGE' — RecurrenceType for schedule e.g EVERYDAY, WEEKDAY_RANGE. - `weekday_from` 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY' — Week day of schedule e.g MONDAY. - `weekday_to` 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY' — Week day of schedule e.g MONDAY. - `start_time2` string, time — The start time of the schedule. - `end_time2` string, time — The end time of the schedule. - `enable_by_cwp` boolean — The flag for enableBypassCwp. --- [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)