Configuration - User Management

Update an end user

Update a specific end user.

put/endusers/{id}

Request

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

Path parameters

idinteger required

The end user ID

Request body

namestring

The user common name

organizationstring

The organization name

visit_purposestring

The purpose of visit

descriptionstring

The user description

email_addressstring

The user email

phone_numberstring

The user phone number

passwordstring

The user password

email_password_deliverystring

The password delivery Email

sms_password_deliverystring

The password delivery SMS

vlan_overrideinteger

VLAN ID override assigned to the user (range 1-4094, Optional)

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 common name

descriptionstring

The user description

email_addressstring required

The user email address

phone_numberstring required

The user phone number

passwordstring

The user password

user_namestring required

The user identifiable name or the same one from common name, emailAddress or phoneNumber

organizationstring

The organization name

visit_purposestring

The purpose of visit

email_password_deliverystring

The email address for password delivery

sms_password_deliverystring

The sms number for password delivery

user_group_idinteger required

The user group ID

user_group_namestring required

The user group name

approval_typestring required

The approval type

expired_timeinteger required

The password expired time

vlan_overrideinteger

VLAN ID override assigned to the user (range 1-4094, Optional)

Changes