Sign in

v4

latestOpenAPI 3.0.1Apache 2.02026-08-036821,1001.5 MB
User

Update external access info

Updates external access info for a specific user.

patch/users/external/{id}

Path parameters

idinteger required

The external user ID

Request body

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

The user administrative role

org_idinteger

The HIQ organization ID if it is HIQ user, otherwise leave it as empty.

location_idsinteger[]

The location IDs to assign.

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