---
title: "Grant external access"
method: POST
path: "/users/external"
tags: ["User"]
---

# Grant external access

`POST /users/external`

Grant external access to a specific user.

## Request body

- XiqGrantExternalUserRequest
  - `login_name` string, 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_id` integer — The HIQ organization ID if it is HIQ user, otherwise leave it as empty
  - `location_ids` integer[] — The location IDs to assign. Null or empty list will assign Admin default locations.
  - `access_scope` integer — The user has access on all sites / the authorized sites. 0: VIQ_SCOPE, 1: SITE_SCOPE.
  - `viq_access_control` integer — The permissions for Site Scope user on Global Scope resources. 0: READ_WRITE, 1: READ_ONLY.

## Response `200`

OK

- XiqExternalUser
  - `id` integer, required — The unique identifier
  - `create_time` string, date-time, required — The create time in UTC (ISO 8601 format)
  - `update_time` string, date-time, required — The last update time in UTC (ISO 8601 format)
  - `login_name` string, 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_id` integer — The HIQ organization ID if it is HIQ user.
  - `location_ids` integer[] — The assigned location IDs.
  - `grantee_id` integer — The home VIQ user ID of external user.
  - `access_scope` integer — The user has access on all sites / the authorized sites. 0: VIQ_SCOPE, 1: SITE_SCOPE.
  - `viq_access_control` integer — The permissions for Site Scope user on Global Scope resources. 0: READ_WRITE, 1: READ_ONLY.

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)