/jira-servicedesk-customers | Type: Application | PCID required: Yes
Tools
jira-servicedesk-customers_add_customers
Add customers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceDeskId | string | Yes | — | The ID of the service desk the customer list should be returned from. This can alternatively be a project identifier. |
accountIds | string[] | No | — | List of users, specified by account IDs, to add to or remove from a service desk. |
usernames | string[] | No | — | This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. Use accountIds instead. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"serviceDeskId": {
"type": "string",
"description": "The ID of the service desk the customer list should be returned from. This can alternatively be a [project identifier.](#project-identifiers)"
},
"accountIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of users, specified by account IDs, to add to or remove from a service desk."
},
"usernames": {
"type": "array",
"items": {
"type": "string"
},
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Use `accountIds` instead."
}
},
"required": [
"PCID",
"serviceDeskId"
]
}
jira-servicedesk-customers_add_organization
Add organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceDeskId | string | Yes | — | The ID of the service desk to which the organization will be added. This can alternatively be a project identifier. |
organizationId | integer | Yes | — | List of organizations, specified by ‘ID’ field values, to add to or remove from the service desk. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"serviceDeskId": {
"type": "string",
"description": "The ID of the service desk to which the organization will be added. This can alternatively be a [project identifier.](#project-identifiers)"
},
"organizationId": {
"type": "integer",
"description": "List of organizations, specified by 'ID' field values, to add to or remove from the service desk."
}
},
"required": [
"PCID",
"serviceDeskId",
"organizationId"
]
}
jira-servicedesk-customers_add_users_to_organization
Add users to organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organizationId | integer | Yes | — | The ID of the organization. |
accountIds | string[] | No | — | List of customers, specific by account IDs, to add to or remove from the organization. |
usernames | string[] | No | — | This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. Use accountIds instead. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organizationId": {
"type": "integer",
"description": "The ID of the organization."
},
"accountIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of customers, specific by account IDs, to add to or remove from the organization."
},
"usernames": {
"type": "array",
"items": {
"type": "string"
},
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Use `accountIds` instead."
}
},
"required": [
"PCID",
"organizationId"
]
}
jira-servicedesk-customers_create_customer
Create customer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
strictConflictStatusCode | boolean | No | — | Optional boolean flag to return 409 Conflict status code for duplicate customer creation request |
displayName | string | Yes | — | Customer’s name for display in the UI. |
email | string | Yes | — | Customer’s email address. |
fullName | string | No | — | Deprecated, please use ‘displayName’. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"strictConflictStatusCode": {
"type": "boolean",
"description": "Optional boolean flag to return 409 Conflict status code for duplicate customer creation request"
},
"displayName": {
"type": "string",
"description": "Customer's name for display in the UI."
},
"email": {
"type": "string",
"description": "Customer's email address."
},
"fullName": {
"type": "string",
"description": "Deprecated, please use 'displayName'."
}
},
"required": [
"PCID",
"displayName",
"email"
]
}
jira-servicedesk-customers_create_organization
Create organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | Name of the organization. Must contain 1-200 characters. |
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 organization. Must contain 1-200 characters."
}
},
"required": [
"PCID",
"name"
]
}
jira-servicedesk-customers_delete_organization
Delete organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organizationId | integer | Yes | — | The ID of the organization. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organizationId": {
"type": "integer",
"description": "The ID of the organization."
}
},
"required": [
"PCID",
"organizationId"
]
}
jira-servicedesk-customers_get_customers
Get customers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceDeskId | string | Yes | — | The ID of the service desk the customer list should be returned from. This can alternatively be a project identifier. |
query | string | No | — | The string used to filter the customer list. |
start | integer | No | — | The starting index of the returned objects. Base index: 0. See the Pagination section for more details. |
limit | integer | No | — | The maximum number of users to return per page. Default: 50. See the Pagination section for more details. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"serviceDeskId": {
"type": "string",
"description": "The ID of the service desk the customer list should be returned from. This can alternatively be a [project identifier.](#project-identifiers)"
},
"query": {
"type": "string",
"description": "The string used to filter the customer list."
},
"start": {
"type": "integer",
"description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details."
},
"limit": {
"type": "integer",
"description": "The maximum number of users to return per page. Default: 50. See the [Pagination](#pagination) section for more details."
}
},
"required": [
"PCID",
"serviceDeskId"
]
}
jira-servicedesk-customers_get_organization
Get organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organizationId | integer | Yes | — | The ID of the organization. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organizationId": {
"type": "integer",
"description": "The ID of the organization."
}
},
"required": [
"PCID",
"organizationId"
]
}
jira-servicedesk-customers_get_organizations
Get organizations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
start | integer | No | — | The starting index of the returned objects. Base index: 0. See the Pagination section for more details. |
limit | integer | No | — | The maximum number of organizations to return per page. Default: 50. See the Pagination section for more details. |
accountId | string | No | — | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"start": {
"type": "integer",
"description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details."
},
"limit": {
"type": "integer",
"description": "The maximum number of organizations to return per page. Default: 50. See the [Pagination](#pagination) section for more details."
},
"accountId": {
"type": "string",
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
}
},
"required": [
"PCID"
]
}
jira-servicedesk-customers_get_service_desk_organizations
Get organizations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceDeskId | string | Yes | — | The ID of the service desk from which the organization list will be returned. This can alternatively be a project identifier. |
start | integer | No | — | The starting index of the returned objects. Base index: 0. See the Pagination section for more details. |
limit | integer | No | — | The maximum number of items to return per page. Default: 50. See the Pagination section for more details. |
accountId | string | No | — | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"serviceDeskId": {
"type": "string",
"description": "The ID of the service desk from which the organization list will be returned. This can alternatively be a [project identifier.](#project-identifiers)"
},
"start": {
"type": "integer",
"description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details."
},
"limit": {
"type": "integer",
"description": "The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details."
},
"accountId": {
"type": "string",
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
}
},
"required": [
"PCID",
"serviceDeskId"
]
}
jira-servicedesk-customers_get_users_in_organization
Get users in organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organizationId | integer | Yes | — | The ID of the organization. |
start | integer | No | — | The starting index of the returned objects. Base index: 0. See the Pagination section for more details. |
limit | integer | No | — | The maximum number of users to return per page. Default: 50. See the Pagination section for more details. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organizationId": {
"type": "integer",
"description": "The ID of the organization."
},
"start": {
"type": "integer",
"description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details."
},
"limit": {
"type": "integer",
"description": "The maximum number of users to return per page. Default: 50. See the [Pagination](#pagination) section for more details."
}
},
"required": [
"PCID",
"organizationId"
]
}
jira-servicedesk-customers_invite_customer
Invite customer Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceDeskId | string | Yes | — | The ID of the service desk to which the newly created customer should be added. |
strictConflictStatusCode | boolean | No | — | Optional boolean flag to return 409 Conflict status code when a customer with the same email already exists. |
displayName | string | No | — | Customer’s name for display in the UI. |
email | string | Yes | — | Customer’s email address. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"serviceDeskId": {
"type": "string",
"description": "The ID of the service desk to which the newly created customer should be added."
},
"strictConflictStatusCode": {
"type": "boolean",
"description": "Optional boolean flag to return 409 Conflict status code when a customer with the same email already exists."
},
"displayName": {
"type": "string",
"description": "Customer's name for display in the UI."
},
"email": {
"type": "string",
"description": "Customer's email address."
}
},
"required": [
"PCID",
"serviceDeskId",
"email"
]
}
jira-servicedesk-customers_remove_customers
Remove customers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceDeskId | string | Yes | — | The ID of the service desk the customers should be removed from. This can alternatively be a project identifier. |
accountIds | string[] | No | — | List of users, specified by account IDs, to add to or remove from a service desk. |
usernames | string[] | No | — | This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. Use accountIds instead. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"serviceDeskId": {
"type": "string",
"description": "The ID of the service desk the customers should be removed from. This can alternatively be a [project identifier.](#project-identifiers)"
},
"accountIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of users, specified by account IDs, to add to or remove from a service desk."
},
"usernames": {
"type": "array",
"items": {
"type": "string"
},
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Use `accountIds` instead."
}
},
"required": [
"PCID",
"serviceDeskId"
]
}
jira-servicedesk-customers_remove_organization
Remove organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
serviceDeskId | string | Yes | — | The ID of the service desk from which the organization will be removed. This can alternatively be a project identifier. |
organizationId | integer | Yes | — | List of organizations, specified by ‘ID’ field values, to add to or remove from the service desk. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"serviceDeskId": {
"type": "string",
"description": "The ID of the service desk from which the organization will be removed. This can alternatively be a [project identifier.](#project-identifiers)"
},
"organizationId": {
"type": "integer",
"description": "List of organizations, specified by 'ID' field values, to add to or remove from the service desk."
}
},
"required": [
"PCID",
"serviceDeskId",
"organizationId"
]
}
jira-servicedesk-customers_remove_users_from_organization
Remove users from organization Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
organizationId | integer | Yes | — | The ID of the organization. |
accountIds | string[] | No | — | List of customers, specific by account IDs, to add to or remove from the organization. |
usernames | string[] | No | — | This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. Use accountIds instead. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"organizationId": {
"type": "integer",
"description": "The ID of the organization."
},
"accountIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of customers, specific by account IDs, to add to or remove from the organization."
},
"usernames": {
"type": "array",
"items": {
"type": "string"
},
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Use `accountIds` instead."
}
},
"required": [
"PCID",
"organizationId"
]
}
jira-servicedesk-customers_revoke_portal_only_access_for_user
Revoke portal only access for user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
accountId | string | Yes | — | The account ID of the user, which uniquely identifies the portal-only account. For example, qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"accountId": {
"type": "string",
"description": "The account ID of the user, which uniquely identifies the portal-only account. For example, *qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b*."
}
},
"required": [
"PCID",
"accountId"
]
}