Skip to main content
Server path: /invgate-service-management-users | Type: Application | PCID required: Yes

Tools

ToolDescription
invgate_service_management_users_add_users_to_companyAdd users to company
invgate_service_management_users_add_users_to_groupAdd users to group
invgate_service_management_users_add_users_to_locationAdd users to location
invgate_service_management_users_convert_user_typeConvert user type
invgate_service_management_users_create_companyCreate company
invgate_service_management_users_create_groupCreate user group
invgate_service_management_users_create_locationCreate location
invgate_service_management_users_create_userCreate user
invgate_service_management_users_delete_companyDelete company
invgate_service_management_users_delete_groupDelete user group
invgate_service_management_users_delete_locationDelete location
invgate_service_management_users_delete_userDelete user
invgate_service_management_users_disable_userDisable user
invgate_service_management_users_enable_userEnable user
invgate_service_management_users_get_userGet user
invgate_service_management_users_get_user_by_filterGet user by filter
invgate_service_management_users_list_companiesList companies
invgate_service_management_users_list_company_usersList company users
invgate_service_management_users_list_group_usersList group users
invgate_service_management_users_list_groupsList user groups
invgate_service_management_users_list_help_desksList help desks
invgate_service_management_users_list_location_usersList location users
invgate_service_management_users_list_locationsList locations
invgate_service_management_users_list_user_groupsList user’s groups
invgate_service_management_users_list_usersList users
invgate_service_management_users_list_users_by_filterList users by filter
invgate_service_management_users_remove_users_from_companyRemove users from company
invgate_service_management_users_remove_users_from_groupRemove users from group
invgate_service_management_users_remove_users_from_locationRemove users from location
invgate_service_management_users_update_companyUpdate company
invgate_service_management_users_update_userUpdate user

invgate_service_management_users_add_users_to_company

Add users to company Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCompany ID
usersinteger[]YesList of user IDs to add

invgate_service_management_users_add_users_to_group

Add users to group Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesGroup ID
usersinteger[]YesList of user IDs to add

invgate_service_management_users_add_users_to_location

Add users to location Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesLocation ID
usersinteger[]YesList of user IDs to add

invgate_service_management_users_convert_user_type

Convert user type Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesUser ID
is_agentbooleanYesWhether to convert the user to an agent (true) or end user (false)

invgate_service_management_users_create_company

Create company Parameters:
ParameterTypeRequiredDefaultDescription
external_idstringNoExternal identifier for the company
namestringYesName of the company

invgate_service_management_users_create_group

Create user group Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesName of the group

invgate_service_management_users_create_location

Create location Parameters:
ParameterTypeRequiredDefaultDescription
namestringYesName of the location
parent_idintegerNoParent location ID

invgate_service_management_users_create_user

Create user Parameters:
ParameterTypeRequiredDefaultDescription
company_idintegerNoCompany ID for the user
emailstringYesUser email address
first_namestringYesUser first name
group_idsinteger[]NoList of group IDs to assign the user to
is_agentbooleanNoWhether the user is an agent
last_namestringYesUser last name
location_idintegerNoLocation ID for the user
mobilestringNoUser mobile number
phonestringNoUser phone number

invgate_service_management_users_delete_company

Delete company Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCompany ID to delete

invgate_service_management_users_delete_group

Delete user group Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesGroup ID to delete

invgate_service_management_users_delete_location

Delete location Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesLocation ID to delete

invgate_service_management_users_delete_user

Delete user Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesUser ID to delete

invgate_service_management_users_disable_user

Disable user Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesUser ID to disable

invgate_service_management_users_enable_user

Enable user Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesUser ID to enable

invgate_service_management_users_get_user

Get user Parameters:
ParameterTypeRequiredDefaultDescription
idintegerNoUser ID
emailstringNoUser email address
usernamestringNoThe username value

invgate_service_management_users_get_user_by_filter

Get user by filter Parameters:
ParameterTypeRequiredDefaultDescription
idintegerNoUser ID
emailstringNoUser email address
usernamestringNoThe username value
external_idstringNoExternal user ID

invgate_service_management_users_list_companies

List companies Parameters:
ParameterTypeRequiredDefaultDescription
external_idstringNoFilter by external ID
idintegerNoFilter by company ID
namestringNoFilter by company name

invgate_service_management_users_list_company_users

List company users Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCompany ID
user_idintegerNoFilter by specific user ID

invgate_service_management_users_list_group_users

List group users Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesGroup ID
user_idintegerNoFilter by specific user ID

invgate_service_management_users_list_groups

List user groups Parameters:
ParameterTypeRequiredDefaultDescription
idintegerNoFilter by group ID
namestringNoFilter by group name

invgate_service_management_users_list_help_desks

List help desks Parameters:
ParameterTypeRequiredDefaultDescription
idintegerNoFilter by help desk ID
include_deletedbooleanNoWhether to include deleted help desks
namestringNoFilter by help desk name

invgate_service_management_users_list_location_users

List location users Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesLocation ID
user_idintegerNoFilter by specific user ID

invgate_service_management_users_list_locations

List locations Parameters:
ParameterTypeRequiredDefaultDescription
idintegerNoFilter by location ID
namestringNoFilter by location name

invgate_service_management_users_list_user_groups

List user’s groups Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesUser ID

invgate_service_management_users_list_users

List users Parameters:
ParameterTypeRequiredDefaultDescription
pageintegerNoPage number
page_sizeintegerNoNumber of results per page
is_agentbooleanNoFilter by agent status

invgate_service_management_users_list_users_by_filter

List users by filter Parameters:
ParameterTypeRequiredDefaultDescription
group_idintegerNoFilter by group ID
company_idintegerNoFilter by company ID
location_idintegerNoFilter by location ID
is_agentbooleanNoFilter by agent status

invgate_service_management_users_remove_users_from_company

Remove users from company Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesCompany ID
usersinteger[]YesList of user IDs to remove

invgate_service_management_users_remove_users_from_group

Remove users from group Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesGroup ID
usersinteger[]YesList of user IDs to remove

invgate_service_management_users_remove_users_from_location

Remove users from location Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesLocation ID
usersinteger[]YesList of user IDs to remove

invgate_service_management_users_update_company

Update company Parameters:
ParameterTypeRequiredDefaultDescription
external_idstringNoExternal identifier for the company
idintegerYesCompany ID
namestringNoName of the company

invgate_service_management_users_update_user

Update user Parameters:
ParameterTypeRequiredDefaultDescription
company_idintegerNoCompany ID for the user
emailstringNoUser email address
first_namestringNoUser first name
idintegerYesUser ID
is_agentbooleanNoWhether the user is an agent
last_namestringNoUser last name
location_idintegerNoLocation ID for the user
mobilestringNoUser mobile number
phonestringNoUser phone number