Configuration - User Management

Update user group

Update existing user group information.

put/usergroups/{id}

Request

  • Base URL
    https://api.extremecloudiq.com
  • URL
    https://api.extremecloudiq.com/usergroups/{id}
  • Auth
    HTTP bearer

Path parameters

idinteger required

The user group ID.

Request body

namestring required

The user group name

descriptionstring

The user group description

password_db_location'CLOUD' | 'LOCAL' required
ppsk_use_onlyboolean

Whether it's for PPSK use only

password_type'PPSK' | 'RADIUS' required
enable_max_clients_per_ppskboolean

The enablement for the maximum number of clients per private PSK

max_clients_per_ppskinteger

The maximum number of clients per private PSK

pcg_use_onlyboolean

Whether it's for PCG use only

pcg_type'AP_BASED' | 'KEY_BASED'
enable_cwp_regboolean

Whether to enable CWP registration setting

Response

OK

idinteger required

The unique identifier

create_timestring date-time required

The create time in UTC (ISO 8601 format)

update_timestring date-time required

The last update time in UTC (ISO 8601 format)

org_idinteger

The organization identifier, valid when enabling HIQ feature

namestring required

The user group name

descriptionstring

The user group description

predefinedboolean required

Whether it is predefined

password_db_location'CLOUD' | 'LOCAL' required
password_type'PPSK' | 'RADIUS' required
pcg_use_onlyboolean

Whether it's for PCG use only

pcg_type'AP_BASED' | 'KEY_BASED'
ppsk_use_onlyboolean

Whether it's for PPSK use only

enable_cwp_regboolean

Whether to enable CWP registration setting

user_countinteger required

The user count

ssidsstring[] required

The ssids

Changes

No operation changes recorded.