/invgate-service-management-users | Type: Application | PCID required: Yes
Tools
invgate_service_management_users_add_users_to_company
Add users to company Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Company ID |
users | integer[] | Yes | — | List of user IDs to add |
invgate_service_management_users_add_users_to_group
Add users to group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Group ID |
users | integer[] | Yes | — | List of user IDs to add |
invgate_service_management_users_add_users_to_location
Add users to location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Location ID |
users | integer[] | Yes | — | List of user IDs to add |
invgate_service_management_users_convert_user_type
Convert user type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | User ID |
is_agent | boolean | Yes | — | Whether to convert the user to an agent (true) or end user (false) |
invgate_service_management_users_create_company
Create company Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
external_id | string | No | — | External identifier for the company |
name | string | Yes | — | Name of the company |
invgate_service_management_users_create_group
Create user group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Name of the group |
invgate_service_management_users_create_location
Create location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Name of the location |
parent_id | integer | No | — | Parent location ID |
invgate_service_management_users_create_user
Create user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
company_id | integer | No | — | Company ID for the user |
email | string | Yes | — | User email address |
first_name | string | Yes | — | User first name |
group_ids | integer[] | No | — | List of group IDs to assign the user to |
is_agent | boolean | No | — | Whether the user is an agent |
last_name | string | Yes | — | User last name |
location_id | integer | No | — | Location ID for the user |
mobile | string | No | — | User mobile number |
phone | string | No | — | User phone number |
invgate_service_management_users_delete_company
Delete company Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Company ID to delete |
invgate_service_management_users_delete_group
Delete user group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Group ID to delete |
invgate_service_management_users_delete_location
Delete location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Location ID to delete |
invgate_service_management_users_delete_user
Delete user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | User ID to delete |
invgate_service_management_users_disable_user
Disable user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | User ID to disable |
invgate_service_management_users_enable_user
Enable user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | User ID to enable |
invgate_service_management_users_get_user
Get user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | No | — | User ID |
email | string | No | — | User email address |
username | string | No | — | The username value |
invgate_service_management_users_get_user_by_filter
Get user by filter Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | No | — | User ID |
email | string | No | — | User email address |
username | string | No | — | The username value |
external_id | string | No | — | External user ID |
invgate_service_management_users_list_companies
List companies Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
external_id | string | No | — | Filter by external ID |
id | integer | No | — | Filter by company ID |
name | string | No | — | Filter by company name |
invgate_service_management_users_list_company_users
List company users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Company ID |
user_id | integer | No | — | Filter by specific user ID |
invgate_service_management_users_list_group_users
List group users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Group ID |
user_id | integer | No | — | Filter by specific user ID |
invgate_service_management_users_list_groups
List user groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | No | — | Filter by group ID |
name | string | No | — | Filter by group name |
invgate_service_management_users_list_help_desks
List help desks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | No | — | Filter by help desk ID |
include_deleted | boolean | No | — | Whether to include deleted help desks |
name | string | No | — | Filter by help desk name |
invgate_service_management_users_list_location_users
List location users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Location ID |
user_id | integer | No | — | Filter by specific user ID |
invgate_service_management_users_list_locations
List locations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | No | — | Filter by location ID |
name | string | No | — | Filter by location name |
invgate_service_management_users_list_user_groups
List user’s groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | User ID |
invgate_service_management_users_list_users
List users Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
page | integer | No | — | Page number |
page_size | integer | No | — | Number of results per page |
is_agent | boolean | No | — | Filter by agent status |
invgate_service_management_users_list_users_by_filter
List users by filter Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
group_id | integer | No | — | Filter by group ID |
company_id | integer | No | — | Filter by company ID |
location_id | integer | No | — | Filter by location ID |
is_agent | boolean | No | — | Filter by agent status |
invgate_service_management_users_remove_users_from_company
Remove users from company Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Company ID |
users | integer[] | Yes | — | List of user IDs to remove |
invgate_service_management_users_remove_users_from_group
Remove users from group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Group ID |
users | integer[] | Yes | — | List of user IDs to remove |
invgate_service_management_users_remove_users_from_location
Remove users from location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Location ID |
users | integer[] | Yes | — | List of user IDs to remove |
invgate_service_management_users_update_company
Update company Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
external_id | string | No | — | External identifier for the company |
id | integer | Yes | — | Company ID |
name | string | No | — | Name of the company |
invgate_service_management_users_update_user
Update user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
company_id | integer | No | — | Company ID for the user |
email | string | No | — | User email address |
first_name | string | No | — | User first name |
id | integer | Yes | — | User ID |
is_agent | boolean | No | — | Whether the user is an agent |
last_name | string | No | — | User last name |
location_id | integer | No | — | Location ID for the user |
mobile | string | No | — | User mobile number |
phone | string | No | — | User phone number |

