Sign in

v4

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

Grant external access

Grant external access to a specific user.

post/users/external

Request body

login_namestring required

Login name, i.e. username or login Email

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

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. Null or empty list will assign Admin default locations.

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

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

The user administrative role

org_idinteger

The HIQ organization ID if it is HIQ user.

location_idsinteger[]

The assigned location IDs.

grantee_idinteger

The home VIQ user ID of external user.

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.