User

Update user info

Updates user info for a specific user.

patch/users/{id}

Request

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

Path parameters

idinteger required

The user ID

Request body

login_namestring

Login name, i.e. username or login Email

display_namestring

The user name to display

idle_timeoutinteger

The idle timeout in minutes.

user_role'ADMINISTRATOR' | 'OPERATOR' | 'MONITOR' | 'HELP_DESK' | 'GUEST_MANAGEMENT' | 'OBSERVER' | 'INSTALLER' | 'APPLICATION_OPERATOR'
location_idsinteger[]

The location IDs to reassign.

access_scopeinteger

The user has access on all sites / the authorized sites. 0: VIQ_SCOPE, 1: SITE_SCOPE.

viq_access_controlinteger

The permissions for Site Scope user on Global Scope resources. 0: READ_WRITE, 1: READ_ONLY.

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)

login_namestring required

Login name, i.e. username or login Email

first_namestring

The first name

last_namestring

The last name, i.e. family name

display_namestring

The name to display

phonestring

The Phone Number

job_titlestring

The job title

localestring

The locale

user_role'ADMINISTRATOR' | 'OPERATOR' | 'MONITOR' | 'HELP_DESK' | 'GUEST_MANAGEMENT' | 'OBSERVER' | 'INSTALLER' | 'APPLICATION_OPERATOR'
idle_timeoutinteger

The idle timeout in minutes, the minimum value is 5 minutes and the maximum value is 4 hours

last_login_timestring date-time

The last login time

org_idinteger

The HIQ organization ID if it is HIQ user

location_idsinteger[]

The assigned location IDs.

access_scopeinteger

The user has access on all sites / the authorized sites. 0: VIQ_SCOPE, 1: SITE_SCOPE.

viq_access_controlinteger

The permissions for Site Scope user on Global Scope resources. 0: READ_WRITE, 1: READ_ONLY.

Changes

No operation changes recorded.