/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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Company ID"
},
"users": {
"type": "array",
"items": {
"type": "integer"
},
"description": "List of user IDs to add"
}
},
"required": [
"PCID",
"id",
"users"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Group ID"
},
"users": {
"type": "array",
"items": {
"type": "integer"
},
"description": "List of user IDs to add"
}
},
"required": [
"PCID",
"id",
"users"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Location ID"
},
"users": {
"type": "array",
"items": {
"type": "integer"
},
"description": "List of user IDs to add"
}
},
"required": [
"PCID",
"id",
"users"
]
}
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) |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "User ID"
},
"is_agent": {
"type": "boolean",
"description": "Whether to convert the user to an agent (true) or end user (false)"
}
},
"required": [
"PCID",
"id",
"is_agent"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"external_id": {
"type": "string",
"description": "External identifier for the company"
},
"name": {
"type": "string",
"description": "Name of the company"
}
},
"required": [
"PCID",
"name"
]
}
invgate_service_management_users_create_group
Create user group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Name of the group |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Name of the group"
}
},
"required": [
"PCID",
"name"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"name": {
"type": "string",
"description": "Name of the location"
},
"parent_id": {
"type": "integer",
"description": "Parent location ID"
}
},
"required": [
"PCID",
"name"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"company_id": {
"type": "integer",
"description": "Company ID for the user"
},
"email": {
"type": "string",
"description": "User email address"
},
"first_name": {
"type": "string",
"description": "User first name"
},
"group_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "List of group IDs to assign the user to"
},
"is_agent": {
"type": "boolean",
"description": "Whether the user is an agent"
},
"last_name": {
"type": "string",
"description": "User last name"
},
"location_id": {
"type": "integer",
"description": "Location ID for the user"
},
"mobile": {
"type": "string",
"description": "User mobile number"
},
"phone": {
"type": "string",
"description": "User phone number"
}
},
"required": [
"PCID",
"email",
"first_name",
"last_name"
]
}
invgate_service_management_users_delete_company
Delete company Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Company ID to delete |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Company ID to delete"
}
},
"required": [
"PCID",
"id"
]
}
invgate_service_management_users_delete_group
Delete user group Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Group ID to delete |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Group ID to delete"
}
},
"required": [
"PCID",
"id"
]
}
invgate_service_management_users_delete_location
Delete location Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | Location ID to delete |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Location ID to delete"
}
},
"required": [
"PCID",
"id"
]
}
invgate_service_management_users_delete_user
Delete user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | User ID to delete |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "User ID to delete"
}
},
"required": [
"PCID",
"id"
]
}
invgate_service_management_users_disable_user
Disable user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | User ID to disable |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "User ID to disable"
}
},
"required": [
"PCID",
"id"
]
}
invgate_service_management_users_enable_user
Enable user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | User ID to enable |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "User ID to enable"
}
},
"required": [
"PCID",
"id"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "User ID"
},
"email": {
"type": "string",
"description": "User email address"
},
"username": {
"type": "string",
"description": "The username value"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "User ID"
},
"email": {
"type": "string",
"description": "User email address"
},
"username": {
"type": "string",
"description": "The username value"
},
"external_id": {
"type": "string",
"description": "External user ID"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"external_id": {
"type": "string",
"description": "Filter by external ID"
},
"id": {
"type": "integer",
"description": "Filter by company ID"
},
"name": {
"type": "string",
"description": "Filter by company name"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Company ID"
},
"user_id": {
"type": "integer",
"description": "Filter by specific user ID"
}
},
"required": [
"PCID",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Group ID"
},
"user_id": {
"type": "integer",
"description": "Filter by specific user ID"
}
},
"required": [
"PCID",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Filter by group ID"
},
"name": {
"type": "string",
"description": "Filter by group name"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Filter by help desk ID"
},
"include_deleted": {
"type": "boolean",
"description": "Whether to include deleted help desks"
},
"name": {
"type": "string",
"description": "Filter by help desk name"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Location ID"
},
"user_id": {
"type": "integer",
"description": "Filter by specific user ID"
}
},
"required": [
"PCID",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Filter by location ID"
},
"name": {
"type": "string",
"description": "Filter by location name"
}
},
"required": [
"PCID"
]
}
invgate_service_management_users_list_user_groups
List user’s groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | User ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "User ID"
}
},
"required": [
"PCID",
"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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"page": {
"type": "integer",
"description": "Page number"
},
"page_size": {
"type": "integer",
"description": "Number of results per page"
},
"is_agent": {
"type": "boolean",
"description": "Filter by agent status"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"group_id": {
"type": "integer",
"description": "Filter by group ID"
},
"company_id": {
"type": "integer",
"description": "Filter by company ID"
},
"location_id": {
"type": "integer",
"description": "Filter by location ID"
},
"is_agent": {
"type": "boolean",
"description": "Filter by agent status"
}
},
"required": [
"PCID"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Company ID"
},
"users": {
"type": "array",
"items": {
"type": "integer"
},
"description": "List of user IDs to remove"
}
},
"required": [
"PCID",
"id",
"users"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Group ID"
},
"users": {
"type": "array",
"items": {
"type": "integer"
},
"description": "List of user IDs to remove"
}
},
"required": [
"PCID",
"id",
"users"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Location ID"
},
"users": {
"type": "array",
"items": {
"type": "integer"
},
"description": "List of user IDs to remove"
}
},
"required": [
"PCID",
"id",
"users"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"external_id": {
"type": "string",
"description": "External identifier for the company"
},
"id": {
"type": "integer",
"description": "Company ID"
},
"name": {
"type": "string",
"description": "Name of the company"
}
},
"required": [
"PCID",
"id"
]
}
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"company_id": {
"type": "integer",
"description": "Company ID for the user"
},
"email": {
"type": "string",
"description": "User email address"
},
"first_name": {
"type": "string",
"description": "User first name"
},
"id": {
"type": "integer",
"description": "User ID"
},
"is_agent": {
"type": "boolean",
"description": "Whether the user is an agent"
},
"last_name": {
"type": "string",
"description": "User last name"
},
"location_id": {
"type": "integer",
"description": "Location ID for the user"
},
"mobile": {
"type": "string",
"description": "User mobile number"
},
"phone": {
"type": "string",
"description": "User phone number"
}
},
"required": [
"PCID",
"id"
]
}