mirror of
https://github.com/simstudioai/sim.git
synced 2026-02-10 14:45:16 -05:00
improvement(jsm): destructured outputs for jsm, jira, and added 1password integration (#3174)
* improvement(jsm): destructured outputs for jsm, jira, and added 1password integration * update 1password to support cloud & locally hosted * updated & tested 1pass * added an additional wandConfig for OnePassword & jira search issues * finished jira * removed unused route * updated types * restore old outputs * updated types
This commit is contained in:
@@ -5483,3 +5483,37 @@ export function AgentSkillsIcon(props: SVGProps<SVGSVGElement>) {
|
||||
</svg>
|
||||
)
|
||||
}
|
||||
|
||||
export function OnePasswordIcon(props: SVGProps<SVGSVGElement>) {
|
||||
return (
|
||||
<svg {...props} viewBox='0 0 48 48' xmlns='http://www.w3.org/2000/svg' fill='none'>
|
||||
<circle
|
||||
cx='24'
|
||||
cy='24'
|
||||
r='21.5'
|
||||
stroke='#000000'
|
||||
strokeLinecap='round'
|
||||
strokeLinejoin='round'
|
||||
/>
|
||||
<path
|
||||
d='M28.083,17.28a7.8633,7.8633,0,0,1,0,13.44'
|
||||
stroke='#000000'
|
||||
strokeLinecap='round'
|
||||
strokeLinejoin='round'
|
||||
/>
|
||||
<path
|
||||
d='M19.917,30.72a7.8633,7.8633,0,0,1,0-13.44'
|
||||
stroke='#000000'
|
||||
strokeLinecap='round'
|
||||
strokeLinejoin='round'
|
||||
/>
|
||||
<path
|
||||
d='M26.067,10.43H21.933a2.0172,2.0172,0,0,0-2.016,2.016v6.36c2.358,1.281,2.736,2.562,0,3.843V35.574a2.0169,2.0169,0,0,0,2.016,2.015h4.134a2.0169,2.0169,0,0,0,2.016-2.015V29.213c-2.358-1.281-2.736-2.562,0-3.842V12.446A2.0172,2.0172,0,0,0,26.067,10.43Z'
|
||||
fill='#000000'
|
||||
stroke='#000000'
|
||||
strokeLinecap='round'
|
||||
strokeLinejoin='round'
|
||||
/>
|
||||
</svg>
|
||||
)
|
||||
}
|
||||
|
||||
@@ -80,6 +80,7 @@ import {
|
||||
MySQLIcon,
|
||||
Neo4jIcon,
|
||||
NotionIcon,
|
||||
OnePasswordIcon,
|
||||
OpenAIIcon,
|
||||
OutlookIcon,
|
||||
PackageSearchIcon,
|
||||
@@ -214,6 +215,7 @@ export const blockTypeToIconMap: Record<string, IconComponent> = {
|
||||
neo4j: Neo4jIcon,
|
||||
notion_v2: NotionIcon,
|
||||
onedrive: MicrosoftOneDriveIcon,
|
||||
onepassword: OnePasswordIcon,
|
||||
openai: OpenAIIcon,
|
||||
outlook: OutlookIcon,
|
||||
parallel_ai: ParallelIcon,
|
||||
|
||||
@@ -25,6 +25,7 @@ With Airweave, you can:
|
||||
In Sim, the Airweave integration empowers your agents to search, summarize, and extract insights from all your organization’s data via a single tool. Use Airweave to drive rich, contextual knowledge retrieval within your workflows—whether answering questions, generating summaries, or supporting dynamic decision-making.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Search across your synced data sources using Airweave. Supports semantic search with hybrid, neural, or keyword retrieval strategies. Optionally generate AI-powered answers from search results.
|
||||
|
||||
@@ -43,7 +43,6 @@ Retrieve detailed information about a specific Jira issue
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `projectId` | string | No | Jira project key \(e.g., PROJ\). Optional when retrieving a single issue. |
|
||||
| `issueKey` | string | Yes | Jira issue key to retrieve \(e.g., PROJ-123\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
|
||||
|
||||
@@ -51,13 +50,184 @@ Retrieve detailed information about a specific Jira issue
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `issueKey` | string | Issue key \(e.g., PROJ-123\) |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `id` | string | Issue ID |
|
||||
| `key` | string | Issue key \(e.g., PROJ-123\) |
|
||||
| `self` | string | REST API URL for this issue |
|
||||
| `summary` | string | Issue summary |
|
||||
| `description` | json | Issue description content |
|
||||
| `created` | string | Issue creation timestamp |
|
||||
| `updated` | string | Issue last updated timestamp |
|
||||
| `issue` | json | Complete issue object with all fields |
|
||||
| `description` | string | Issue description text \(extracted from ADF\) |
|
||||
| `status` | object | Issue status |
|
||||
| ↳ `id` | string | Status ID |
|
||||
| ↳ `name` | string | Status name \(e.g., Open, In Progress, Done\) |
|
||||
| ↳ `description` | string | Status description |
|
||||
| ↳ `statusCategory` | object | Status category grouping |
|
||||
| ↳ `id` | number | Status category ID |
|
||||
| ↳ `key` | string | Status category key \(e.g., new, indeterminate, done\) |
|
||||
| ↳ `name` | string | Status category name \(e.g., To Do, In Progress, Done\) |
|
||||
| ↳ `colorName` | string | Status category color \(e.g., blue-gray, yellow, green\) |
|
||||
| `issuetype` | object | Issue type |
|
||||
| ↳ `id` | string | Issue type ID |
|
||||
| ↳ `name` | string | Issue type name \(e.g., Task, Bug, Story, Epic\) |
|
||||
| ↳ `description` | string | Issue type description |
|
||||
| ↳ `subtask` | boolean | Whether this is a subtask type |
|
||||
| ↳ `iconUrl` | string | URL to the issue type icon |
|
||||
| `project` | object | Project the issue belongs to |
|
||||
| ↳ `id` | string | Project ID |
|
||||
| ↳ `key` | string | Project key \(e.g., PROJ\) |
|
||||
| ↳ `name` | string | Project name |
|
||||
| ↳ `projectTypeKey` | string | Project type key \(e.g., software, business\) |
|
||||
| `priority` | object | Issue priority |
|
||||
| ↳ `id` | string | Priority ID |
|
||||
| ↳ `name` | string | Priority name \(e.g., Highest, High, Medium, Low, Lowest\) |
|
||||
| ↳ `iconUrl` | string | URL to the priority icon |
|
||||
| `assignee` | object | Assigned user |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| `reporter` | object | Reporter user |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| `creator` | object | Issue creator |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| `labels` | array | Issue labels |
|
||||
| `components` | array | Issue components |
|
||||
| ↳ `id` | string | Component ID |
|
||||
| ↳ `name` | string | Component name |
|
||||
| ↳ `description` | string | Component description |
|
||||
| `fixVersions` | array | Fix versions |
|
||||
| ↳ `id` | string | Version ID |
|
||||
| ↳ `name` | string | Version name |
|
||||
| ↳ `released` | boolean | Whether the version is released |
|
||||
| ↳ `releaseDate` | string | Release date \(YYYY-MM-DD\) |
|
||||
| `resolution` | object | Issue resolution |
|
||||
| ↳ `id` | string | Resolution ID |
|
||||
| ↳ `name` | string | Resolution name \(e.g., Fixed, Duplicate, Won't Fix\) |
|
||||
| ↳ `description` | string | Resolution description |
|
||||
| `duedate` | string | Due date \(YYYY-MM-DD\) |
|
||||
| `created` | string | ISO 8601 timestamp when the issue was created |
|
||||
| `updated` | string | ISO 8601 timestamp when the issue was last updated |
|
||||
| `resolutiondate` | string | ISO 8601 timestamp when the issue was resolved |
|
||||
| `timetracking` | object | Time tracking information |
|
||||
| ↳ `originalEstimate` | string | Original estimate in human-readable format \(e.g., 1w 2d\) |
|
||||
| ↳ `remainingEstimate` | string | Remaining estimate in human-readable format |
|
||||
| ↳ `timeSpent` | string | Time spent in human-readable format |
|
||||
| ↳ `originalEstimateSeconds` | number | Original estimate in seconds |
|
||||
| ↳ `remainingEstimateSeconds` | number | Remaining estimate in seconds |
|
||||
| ↳ `timeSpentSeconds` | number | Time spent in seconds |
|
||||
| `parent` | object | Parent issue \(for subtasks\) |
|
||||
| ↳ `id` | string | Parent issue ID |
|
||||
| ↳ `key` | string | Parent issue key |
|
||||
| ↳ `summary` | string | Parent issue summary |
|
||||
| `issuelinks` | array | Linked issues |
|
||||
| ↳ `id` | string | Issue link ID |
|
||||
| ↳ `type` | object | Link type information |
|
||||
| ↳ `id` | string | Link type ID |
|
||||
| ↳ `name` | string | Link type name \(e.g., Blocks, Relates\) |
|
||||
| ↳ `inward` | string | Inward description \(e.g., is blocked by\) |
|
||||
| ↳ `outward` | string | Outward description \(e.g., blocks\) |
|
||||
| ↳ `inwardIssue` | object | Inward linked issue |
|
||||
| ↳ `id` | string | Issue ID |
|
||||
| ↳ `key` | string | Issue key |
|
||||
| ↳ `statusName` | string | Issue status name |
|
||||
| ↳ `summary` | string | Issue summary |
|
||||
| ↳ `outwardIssue` | object | Outward linked issue |
|
||||
| ↳ `id` | string | Issue ID |
|
||||
| ↳ `key` | string | Issue key |
|
||||
| ↳ `statusName` | string | Issue status name |
|
||||
| ↳ `summary` | string | Issue summary |
|
||||
| `subtasks` | array | Subtask issues |
|
||||
| ↳ `id` | string | Subtask issue ID |
|
||||
| ↳ `key` | string | Subtask issue key |
|
||||
| ↳ `summary` | string | Subtask summary |
|
||||
| ↳ `statusName` | string | Subtask status name |
|
||||
| ↳ `issueTypeName` | string | Subtask issue type name |
|
||||
| `votes` | object | Vote information |
|
||||
| ↳ `votes` | number | Number of votes |
|
||||
| ↳ `hasVoted` | boolean | Whether the current user has voted |
|
||||
| `watches` | object | Watch information |
|
||||
| ↳ `watchCount` | number | Number of watchers |
|
||||
| ↳ `isWatching` | boolean | Whether the current user is watching |
|
||||
| `comments` | array | Issue comments \(fetched separately\) |
|
||||
| ↳ `id` | string | Comment ID |
|
||||
| ↳ `body` | string | Comment body text \(extracted from ADF\) |
|
||||
| ↳ `author` | object | Comment author |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| ↳ `updateAuthor` | object | User who last updated the comment |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| ↳ `created` | string | ISO 8601 timestamp when the comment was created |
|
||||
| ↳ `updated` | string | ISO 8601 timestamp when the comment was last updated |
|
||||
| ↳ `visibility` | object | Comment visibility restriction |
|
||||
| ↳ `type` | string | Restriction type \(e.g., role, group\) |
|
||||
| ↳ `value` | string | Restriction value \(e.g., Administrators\) |
|
||||
| `worklogs` | array | Issue worklogs \(fetched separately\) |
|
||||
| ↳ `id` | string | Worklog ID |
|
||||
| ↳ `author` | object | Worklog author |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| ↳ `updateAuthor` | object | User who last updated the worklog |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| ↳ `comment` | string | Worklog comment text |
|
||||
| ↳ `started` | string | ISO 8601 timestamp when the work started |
|
||||
| ↳ `timeSpent` | string | Time spent in human-readable format \(e.g., 3h 20m\) |
|
||||
| ↳ `timeSpentSeconds` | number | Time spent in seconds |
|
||||
| ↳ `created` | string | ISO 8601 timestamp when the worklog was created |
|
||||
| ↳ `updated` | string | ISO 8601 timestamp when the worklog was last updated |
|
||||
| `attachments` | array | Issue attachments |
|
||||
| ↳ `id` | string | Attachment ID |
|
||||
| ↳ `filename` | string | Attachment file name |
|
||||
| ↳ `mimeType` | string | MIME type of the attachment |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `content` | string | URL to download the attachment content |
|
||||
| ↳ `thumbnail` | string | URL to the attachment thumbnail |
|
||||
| ↳ `author` | object | Attachment author |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| ↳ `created` | string | ISO 8601 timestamp when the attachment was created |
|
||||
| `issueKey` | string | Issue key \(e.g., PROJ-123\) |
|
||||
| `issue` | json | Complete raw Jira issue object from the API |
|
||||
|
||||
### `jira_update`
|
||||
|
||||
@@ -68,26 +238,32 @@ Update a Jira issue
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `projectId` | string | No | Jira project key \(e.g., PROJ\). Optional when updating a single issue. |
|
||||
| `issueKey` | string | Yes | Jira issue key to update \(e.g., PROJ-123\) |
|
||||
| `summary` | string | No | New summary for the issue |
|
||||
| `description` | string | No | New description for the issue |
|
||||
| `status` | string | No | New status for the issue |
|
||||
| `priority` | string | No | New priority for the issue |
|
||||
| `assignee` | string | No | New assignee for the issue |
|
||||
| `priority` | string | No | New priority ID or name for the issue \(e.g., "High"\) |
|
||||
| `assignee` | string | No | New assignee account ID for the issue |
|
||||
| `labels` | json | No | Labels to set on the issue \(array of label name strings\) |
|
||||
| `components` | json | No | Components to set on the issue \(array of component name strings\) |
|
||||
| `duedate` | string | No | Due date for the issue \(format: YYYY-MM-DD\) |
|
||||
| `fixVersions` | json | No | Fix versions to set \(array of version name strings\) |
|
||||
| `environment` | string | No | Environment information for the issue |
|
||||
| `customFieldId` | string | No | Custom field ID to update \(e.g., customfield_10001\) |
|
||||
| `customFieldValue` | string | No | Value for the custom field |
|
||||
| `notifyUsers` | boolean | No | Whether to send email notifications about this update \(default: true\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `issueKey` | string | Updated issue key \(e.g., PROJ-123\) |
|
||||
| `summary` | string | Issue summary after update |
|
||||
|
||||
### `jira_write`
|
||||
|
||||
Write a Jira issue
|
||||
Create a new Jira issue
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -100,9 +276,12 @@ Write a Jira issue
|
||||
| `priority` | string | No | Priority ID or name for the issue \(e.g., "10000" or "High"\) |
|
||||
| `assignee` | string | No | Assignee account ID for the issue |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
|
||||
| `issueType` | string | Yes | Type of issue to create \(e.g., Task, Story\) |
|
||||
| `issueType` | string | Yes | Type of issue to create \(e.g., Task, Story, Bug, Epic, Sub-task\) |
|
||||
| `parent` | json | No | Parent issue key for creating subtasks \(e.g., \{ "key": "PROJ-123" \}\) |
|
||||
| `labels` | array | No | Labels for the issue \(array of label names\) |
|
||||
| `components` | array | No | Components for the issue \(array of component names\) |
|
||||
| `duedate` | string | No | Due date for the issue \(format: YYYY-MM-DD\) |
|
||||
| `fixVersions` | array | No | Fix versions for the issue \(array of version names\) |
|
||||
| `reporter` | string | No | Reporter account ID for the issue |
|
||||
| `environment` | string | No | Environment information for the issue |
|
||||
| `customFieldId` | string | No | Custom field ID \(e.g., customfield_10001\) |
|
||||
@@ -112,15 +291,17 @@ Write a Jira issue
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `id` | string | Created issue ID |
|
||||
| `issueKey` | string | Created issue key \(e.g., PROJ-123\) |
|
||||
| `self` | string | REST API URL for the created issue |
|
||||
| `summary` | string | Issue summary |
|
||||
| `url` | string | URL to the created issue |
|
||||
| `assigneeId` | string | Account ID of the assigned user \(if assigned\) |
|
||||
| `url` | string | URL to the created issue in Jira |
|
||||
| `assigneeId` | string | Account ID of the assigned user \(null if no assignee was set\) |
|
||||
|
||||
### `jira_bulk_read`
|
||||
|
||||
Retrieve multiple Jira issues in bulk
|
||||
Retrieve multiple Jira issues from a project in bulk
|
||||
|
||||
#### Input
|
||||
|
||||
@@ -134,7 +315,30 @@ Retrieve multiple Jira issues in bulk
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `issues` | array | Array of Jira issues with ts, summary, description, created, and updated timestamps |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `total` | number | Total number of issues in the project \(may not always be available\) |
|
||||
| `issues` | array | Array of Jira issues |
|
||||
| ↳ `id` | string | Issue ID |
|
||||
| ↳ `key` | string | Issue key \(e.g., PROJ-123\) |
|
||||
| ↳ `self` | string | REST API URL for this issue |
|
||||
| ↳ `summary` | string | Issue summary |
|
||||
| ↳ `description` | string | Issue description text |
|
||||
| ↳ `status` | object | Issue status |
|
||||
| ↳ `id` | string | Status ID |
|
||||
| ↳ `name` | string | Status name |
|
||||
| ↳ `issuetype` | object | Issue type |
|
||||
| ↳ `id` | string | Issue type ID |
|
||||
| ↳ `name` | string | Issue type name |
|
||||
| ↳ `priority` | object | Issue priority |
|
||||
| ↳ `id` | string | Priority ID |
|
||||
| ↳ `name` | string | Priority name |
|
||||
| ↳ `assignee` | object | Assigned user |
|
||||
| ↳ `accountId` | string | Atlassian account ID |
|
||||
| ↳ `displayName` | string | Display name |
|
||||
| ↳ `created` | string | ISO 8601 creation timestamp |
|
||||
| ↳ `updated` | string | ISO 8601 last updated timestamp |
|
||||
| `nextPageToken` | string | Cursor token for the next page. Null when no more results. |
|
||||
| `isLast` | boolean | Whether this is the last page of results |
|
||||
|
||||
### `jira_delete_issue`
|
||||
|
||||
@@ -153,7 +357,7 @@ Delete a Jira issue
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `issueKey` | string | Deleted issue key |
|
||||
|
||||
### `jira_assign_issue`
|
||||
@@ -173,9 +377,9 @@ Assign a Jira issue to a user
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `issueKey` | string | Issue key that was assigned |
|
||||
| `assigneeId` | string | Account ID of the assignee |
|
||||
| `assigneeId` | string | Account ID of the assignee \(use "-1" for auto-assign, null to unassign\) |
|
||||
|
||||
### `jira_transition_issue`
|
||||
|
||||
@@ -189,15 +393,20 @@ Move a Jira issue between workflow statuses (e.g., To Do -> In Progress)
|
||||
| `issueKey` | string | Yes | Jira issue key to transition \(e.g., PROJ-123\) |
|
||||
| `transitionId` | string | Yes | ID of the transition to execute \(e.g., "11" for "To Do", "21" for "In Progress"\) |
|
||||
| `comment` | string | No | Optional comment to add when transitioning the issue |
|
||||
| `resolution` | string | No | Resolution name to set during transition \(e.g., "Fixed", "Won\'t Fix"\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `issueKey` | string | Issue key that was transitioned |
|
||||
| `transitionId` | string | Applied transition ID |
|
||||
| `transitionName` | string | Applied transition name |
|
||||
| `toStatus` | object | Target status after transition |
|
||||
| ↳ `id` | string | Status ID |
|
||||
| ↳ `name` | string | Status name |
|
||||
|
||||
### `jira_search_issues`
|
||||
|
||||
@@ -209,20 +418,77 @@ Search for Jira issues using JQL (Jira Query Language)
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `jql` | string | Yes | JQL query string to search for issues \(e.g., "project = PROJ AND status = Open"\) |
|
||||
| `startAt` | number | No | The index of the first result to return \(for pagination\) |
|
||||
| `maxResults` | number | No | Maximum number of results to return \(default: 50\) |
|
||||
| `fields` | array | No | Array of field names to return \(default: \['summary', 'status', 'assignee', 'created', 'updated'\]\) |
|
||||
| `nextPageToken` | string | No | Cursor token for the next page of results. Omit for the first page. |
|
||||
| `maxResults` | number | No | Maximum number of results to return per page \(default: 50\) |
|
||||
| `fields` | array | No | Array of field names to return \(default: all navigable\). Use "*all" for every field. |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `total` | number | Total number of matching issues |
|
||||
| `startAt` | number | Pagination start index |
|
||||
| `maxResults` | number | Maximum results per page |
|
||||
| `issues` | array | Array of matching issues with key, summary, status, assignee, created, updated |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `issues` | array | Array of matching issues |
|
||||
| ↳ `id` | string | Issue ID |
|
||||
| ↳ `key` | string | Issue key \(e.g., PROJ-123\) |
|
||||
| ↳ `self` | string | REST API URL for this issue |
|
||||
| ↳ `summary` | string | Issue summary |
|
||||
| ↳ `description` | string | Issue description text \(extracted from ADF\) |
|
||||
| ↳ `status` | object | Issue status |
|
||||
| ↳ `id` | string | Status ID |
|
||||
| ↳ `name` | string | Status name \(e.g., Open, In Progress, Done\) |
|
||||
| ↳ `description` | string | Status description |
|
||||
| ↳ `statusCategory` | object | Status category grouping |
|
||||
| ↳ `id` | number | Status category ID |
|
||||
| ↳ `key` | string | Status category key \(e.g., new, indeterminate, done\) |
|
||||
| ↳ `name` | string | Status category name \(e.g., To Do, In Progress, Done\) |
|
||||
| ↳ `colorName` | string | Status category color \(e.g., blue-gray, yellow, green\) |
|
||||
| ↳ `issuetype` | object | Issue type |
|
||||
| ↳ `id` | string | Issue type ID |
|
||||
| ↳ `name` | string | Issue type name \(e.g., Task, Bug, Story, Epic\) |
|
||||
| ↳ `description` | string | Issue type description |
|
||||
| ↳ `subtask` | boolean | Whether this is a subtask type |
|
||||
| ↳ `iconUrl` | string | URL to the issue type icon |
|
||||
| ↳ `project` | object | Project the issue belongs to |
|
||||
| ↳ `id` | string | Project ID |
|
||||
| ↳ `key` | string | Project key \(e.g., PROJ\) |
|
||||
| ↳ `name` | string | Project name |
|
||||
| ↳ `projectTypeKey` | string | Project type key \(e.g., software, business\) |
|
||||
| ↳ `priority` | object | Issue priority |
|
||||
| ↳ `id` | string | Priority ID |
|
||||
| ↳ `name` | string | Priority name \(e.g., Highest, High, Medium, Low, Lowest\) |
|
||||
| ↳ `iconUrl` | string | URL to the priority icon |
|
||||
| ↳ `assignee` | object | Assigned user |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| ↳ `reporter` | object | Reporter user |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| ↳ `labels` | array | Issue labels |
|
||||
| ↳ `components` | array | Issue components |
|
||||
| ↳ `id` | string | Component ID |
|
||||
| ↳ `name` | string | Component name |
|
||||
| ↳ `description` | string | Component description |
|
||||
| ↳ `resolution` | object | Issue resolution |
|
||||
| ↳ `id` | string | Resolution ID |
|
||||
| ↳ `name` | string | Resolution name \(e.g., Fixed, Duplicate, Won't Fix\) |
|
||||
| ↳ `description` | string | Resolution description |
|
||||
| ↳ `duedate` | string | Due date \(YYYY-MM-DD\) |
|
||||
| ↳ `created` | string | ISO 8601 timestamp when the issue was created |
|
||||
| ↳ `updated` | string | ISO 8601 timestamp when the issue was last updated |
|
||||
| `nextPageToken` | string | Cursor token for the next page. Null when no more results. |
|
||||
| `isLast` | boolean | Whether this is the last page of results |
|
||||
| `total` | number | Total number of matching issues \(may not always be available\) |
|
||||
|
||||
### `jira_add_comment`
|
||||
|
||||
@@ -235,16 +501,27 @@ Add a comment to a Jira issue
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `issueKey` | string | Yes | Jira issue key to add comment to \(e.g., PROJ-123\) |
|
||||
| `body` | string | Yes | Comment body text |
|
||||
| `visibility` | json | No | Restrict comment visibility. Object with "type" \("role" or "group"\) and "value" \(role/group name\). |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `issueKey` | string | Issue key the comment was added to |
|
||||
| `commentId` | string | Created comment ID |
|
||||
| `body` | string | Comment text content |
|
||||
| `author` | object | Comment author |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| `created` | string | ISO 8601 timestamp when the comment was created |
|
||||
| `updated` | string | ISO 8601 timestamp when the comment was last updated |
|
||||
|
||||
### `jira_get_comments`
|
||||
|
||||
@@ -258,16 +535,42 @@ Get all comments from a Jira issue
|
||||
| `issueKey` | string | Yes | Jira issue key to get comments from \(e.g., PROJ-123\) |
|
||||
| `startAt` | number | No | Index of the first comment to return \(default: 0\) |
|
||||
| `maxResults` | number | No | Maximum number of comments to return \(default: 50\) |
|
||||
| `orderBy` | string | No | Sort order for comments: "-created" for newest first, "created" for oldest first |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `issueKey` | string | Issue key |
|
||||
| `total` | number | Total number of comments |
|
||||
| `comments` | array | Array of comments with id, author, body, created, updated |
|
||||
| `startAt` | number | Pagination start index |
|
||||
| `maxResults` | number | Maximum results per page |
|
||||
| `comments` | array | Array of comments |
|
||||
| ↳ `id` | string | Comment ID |
|
||||
| ↳ `body` | string | Comment body text \(extracted from ADF\) |
|
||||
| ↳ `author` | object | Comment author |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| ↳ `updateAuthor` | object | User who last updated the comment |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| ↳ `created` | string | ISO 8601 timestamp when the comment was created |
|
||||
| ↳ `updated` | string | ISO 8601 timestamp when the comment was last updated |
|
||||
| ↳ `visibility` | object | Comment visibility restriction |
|
||||
| ↳ `type` | string | Restriction type \(e.g., role, group\) |
|
||||
| ↳ `value` | string | Restriction value \(e.g., Administrators\) |
|
||||
|
||||
### `jira_update_comment`
|
||||
|
||||
@@ -281,16 +584,27 @@ Update an existing comment on a Jira issue
|
||||
| `issueKey` | string | Yes | Jira issue key containing the comment \(e.g., PROJ-123\) |
|
||||
| `commentId` | string | Yes | ID of the comment to update |
|
||||
| `body` | string | Yes | Updated comment text |
|
||||
| `visibility` | json | No | Restrict comment visibility. Object with "type" \("role" or "group"\) and "value" \(role/group name\). |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `issueKey` | string | Issue key |
|
||||
| `commentId` | string | Updated comment ID |
|
||||
| `body` | string | Updated comment text |
|
||||
| `author` | object | Comment author |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| `created` | string | ISO 8601 timestamp when the comment was created |
|
||||
| `updated` | string | ISO 8601 timestamp when the comment was last updated |
|
||||
|
||||
### `jira_delete_comment`
|
||||
|
||||
@@ -309,7 +623,7 @@ Delete a comment from a Jira issue
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `issueKey` | string | Issue key |
|
||||
| `commentId` | string | Deleted comment ID |
|
||||
|
||||
@@ -329,9 +643,24 @@ Get all attachments from a Jira issue
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `issueKey` | string | Issue key |
|
||||
| `attachments` | array | Array of attachments with id, filename, size, mimeType, created, author |
|
||||
| `attachments` | array | Array of attachments |
|
||||
| ↳ `id` | string | Attachment ID |
|
||||
| ↳ `filename` | string | Attachment file name |
|
||||
| ↳ `mimeType` | string | MIME type of the attachment |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `content` | string | URL to download the attachment content |
|
||||
| ↳ `thumbnail` | string | URL to the attachment thumbnail |
|
||||
| ↳ `author` | object | Attachment author |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| ↳ `created` | string | ISO 8601 timestamp when the attachment was created |
|
||||
|
||||
### `jira_add_attachment`
|
||||
|
||||
@@ -350,10 +679,19 @@ Add attachments to a Jira issue
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `issueKey` | string | Issue key |
|
||||
| `attachmentIds` | json | IDs of uploaded attachments |
|
||||
| `files` | file[] | Uploaded attachment files |
|
||||
| `attachments` | array | Uploaded attachments |
|
||||
| ↳ `id` | string | Attachment ID |
|
||||
| ↳ `filename` | string | Attachment file name |
|
||||
| ↳ `mimeType` | string | MIME type |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
| ↳ `content` | string | URL to download the attachment |
|
||||
| `attachmentIds` | array | Array of attachment IDs |
|
||||
| `files` | array | Uploaded file metadata |
|
||||
| ↳ `name` | string | File name |
|
||||
| ↳ `mimeType` | string | MIME type |
|
||||
| ↳ `size` | number | File size in bytes |
|
||||
|
||||
### `jira_delete_attachment`
|
||||
|
||||
@@ -371,7 +709,7 @@ Delete an attachment from a Jira issue
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `attachmentId` | string | Deleted attachment ID |
|
||||
|
||||
### `jira_add_worklog`
|
||||
@@ -387,16 +725,28 @@ Add a time tracking worklog entry to a Jira issue
|
||||
| `timeSpentSeconds` | number | Yes | Time spent in seconds |
|
||||
| `comment` | string | No | Optional comment for the worklog entry |
|
||||
| `started` | string | No | Optional start time in ISO format \(defaults to current time\) |
|
||||
| `visibility` | json | No | Restrict worklog visibility. Object with "type" \("role" or "group"\) and "value" \(role/group name\). |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `issueKey` | string | Issue key the worklog was added to |
|
||||
| `worklogId` | string | Created worklog ID |
|
||||
| `timeSpent` | string | Time spent in human-readable format \(e.g., 3h 20m\) |
|
||||
| `timeSpentSeconds` | number | Time spent in seconds |
|
||||
| `author` | object | Worklog author |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| `started` | string | ISO 8601 timestamp when the work started |
|
||||
| `created` | string | ISO 8601 timestamp when the worklog was created |
|
||||
|
||||
### `jira_get_worklogs`
|
||||
|
||||
@@ -416,10 +766,35 @@ Get all worklog entries from a Jira issue
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `issueKey` | string | Issue key |
|
||||
| `total` | number | Total number of worklogs |
|
||||
| `worklogs` | array | Array of worklogs with id, author, timeSpentSeconds, timeSpent, comment, created, updated, started |
|
||||
| `startAt` | number | Pagination start index |
|
||||
| `maxResults` | number | Maximum results per page |
|
||||
| `worklogs` | array | Array of worklogs |
|
||||
| ↳ `id` | string | Worklog ID |
|
||||
| ↳ `author` | object | Worklog author |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| ↳ `updateAuthor` | object | User who last updated the worklog |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| ↳ `comment` | string | Worklog comment text |
|
||||
| ↳ `started` | string | ISO 8601 timestamp when the work started |
|
||||
| ↳ `timeSpent` | string | Time spent in human-readable format \(e.g., 3h 20m\) |
|
||||
| ↳ `timeSpentSeconds` | number | Time spent in seconds |
|
||||
| ↳ `created` | string | ISO 8601 timestamp when the worklog was created |
|
||||
| ↳ `updated` | string | ISO 8601 timestamp when the worklog was last updated |
|
||||
|
||||
### `jira_update_worklog`
|
||||
|
||||
@@ -435,15 +810,38 @@ Update an existing worklog entry on a Jira issue
|
||||
| `timeSpentSeconds` | number | No | Time spent in seconds |
|
||||
| `comment` | string | No | Optional comment for the worklog entry |
|
||||
| `started` | string | No | Optional start time in ISO format |
|
||||
| `visibility` | json | No | Restrict worklog visibility. Object with "type" \("role" or "group"\) and "value" \(role/group name\). |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance. If not provided, it will be fetched using the domain. |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `issueKey` | string | Issue key |
|
||||
| `worklogId` | string | Updated worklog ID |
|
||||
| `timeSpent` | string | Human-readable time spent \(e.g., "3h 20m"\) |
|
||||
| `timeSpentSeconds` | number | Time spent in seconds |
|
||||
| `comment` | string | Worklog comment text |
|
||||
| `author` | object | Worklog author |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| `updateAuthor` | object | User who last updated the worklog |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| `started` | string | Worklog start time in ISO format |
|
||||
| `created` | string | Worklog creation time |
|
||||
| `updated` | string | Worklog last update time |
|
||||
|
||||
### `jira_delete_worklog`
|
||||
|
||||
@@ -462,7 +860,7 @@ Delete a worklog entry from a Jira issue
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `issueKey` | string | Issue key |
|
||||
| `worklogId` | string | Deleted worklog ID |
|
||||
|
||||
@@ -485,7 +883,7 @@ Create a link relationship between two Jira issues
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `inwardIssue` | string | Inward issue key |
|
||||
| `outwardIssue` | string | Outward issue key |
|
||||
| `linkType` | string | Type of issue link |
|
||||
@@ -507,7 +905,7 @@ Delete a link between two Jira issues
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `linkId` | string | Deleted link ID |
|
||||
|
||||
### `jira_add_watcher`
|
||||
@@ -527,7 +925,7 @@ Add a watcher to a Jira issue to receive notifications about updates
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `issueKey` | string | Issue key |
|
||||
| `watcherAccountId` | string | Added watcher account ID |
|
||||
|
||||
@@ -548,7 +946,7 @@ Remove a watcher from a Jira issue
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `issueKey` | string | Issue key |
|
||||
| `watcherAccountId` | string | Removed watcher account ID |
|
||||
|
||||
@@ -570,8 +968,15 @@ Get Jira users. If an account ID is provided, returns a single user. Otherwise,
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `users` | json | Array of users with accountId, displayName, emailAddress, active status, and avatarUrls |
|
||||
| `ts` | string | ISO 8601 timestamp of the operation |
|
||||
| `users` | array | Array of Jira users |
|
||||
| ↳ `accountId` | string | Atlassian account ID of the user |
|
||||
| ↳ `displayName` | string | Display name of the user |
|
||||
| ↳ `active` | boolean | Whether the user account is active |
|
||||
| ↳ `emailAddress` | string | Email address of the user |
|
||||
| ↳ `accountType` | string | Type of account \(e.g., atlassian, app, customer\) |
|
||||
| ↳ `avatarUrl` | string | URL to the user avatar \(48x48\) |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| `total` | number | Total number of users returned |
|
||||
| `startAt` | number | Pagination start index |
|
||||
| `maxResults` | number | Maximum results per page |
|
||||
|
||||
@@ -46,6 +46,7 @@ Get all service desks from Jira Service Management
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `expand` | string | No | Comma-separated fields to expand in the response |
|
||||
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||
|
||||
@@ -54,7 +55,14 @@ Get all service desks from Jira Service Management
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `serviceDesks` | json | Array of service desks |
|
||||
| `serviceDesks` | array | List of service desks |
|
||||
| ↳ `id` | string | Service desk ID |
|
||||
| ↳ `projectId` | string | Associated Jira project ID |
|
||||
| ↳ `projectName` | string | Associated project name |
|
||||
| ↳ `projectKey` | string | Associated project key |
|
||||
| ↳ `name` | string | Service desk name |
|
||||
| ↳ `description` | string | Service desk description |
|
||||
| ↳ `leadDisplayName` | string | Project lead display name |
|
||||
| `total` | number | Total number of service desks |
|
||||
| `isLastPage` | boolean | Whether this is the last page |
|
||||
|
||||
@@ -69,6 +77,9 @@ Get request types for a service desk in Jira Service Management
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) |
|
||||
| `searchQuery` | string | No | Filter request types by name |
|
||||
| `groupId` | string | No | Filter by request type group ID |
|
||||
| `expand` | string | No | Comma-separated fields to expand in the response |
|
||||
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||
|
||||
@@ -77,7 +88,16 @@ Get request types for a service desk in Jira Service Management
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `requestTypes` | json | Array of request types |
|
||||
| `requestTypes` | array | List of request types |
|
||||
| ↳ `id` | string | Request type ID |
|
||||
| ↳ `name` | string | Request type name |
|
||||
| ↳ `description` | string | Request type description |
|
||||
| ↳ `helpText` | string | Help text for customers |
|
||||
| ↳ `issueTypeId` | string | Associated Jira issue type ID |
|
||||
| ↳ `serviceDeskId` | string | Parent service desk ID |
|
||||
| ↳ `groupIds` | json | Groups this request type belongs to |
|
||||
| ↳ `icon` | json | Request type icon with id and links |
|
||||
| ↳ `restrictionStatus` | string | OPEN or RESTRICTED |
|
||||
| `total` | number | Total number of request types |
|
||||
| `isLastPage` | boolean | Whether this is the last page |
|
||||
|
||||
@@ -96,6 +116,9 @@ Create a new service request in Jira Service Management
|
||||
| `summary` | string | Yes | Summary/title for the service request |
|
||||
| `description` | string | No | Description for the service request |
|
||||
| `raiseOnBehalfOf` | string | No | Account ID of customer to raise request on behalf of |
|
||||
| `requestFieldValues` | json | No | Custom field values as key-value pairs \(overrides summary/description if provided\) |
|
||||
| `requestParticipants` | string | No | Comma-separated account IDs to add as request participants |
|
||||
| `channel` | string | No | Channel the request originates from \(e.g., portal, email\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -106,6 +129,9 @@ Create a new service request in Jira Service Management
|
||||
| `issueKey` | string | Created request issue key \(e.g., SD-123\) |
|
||||
| `requestTypeId` | string | Request type ID |
|
||||
| `serviceDeskId` | string | Service desk ID |
|
||||
| `createdDate` | json | Creation date with iso8601, friendly, epochMillis |
|
||||
| `currentStatus` | json | Current status with status name and category |
|
||||
| `reporter` | json | Reporter user with accountId, displayName, emailAddress |
|
||||
| `success` | boolean | Whether the request was created successfully |
|
||||
| `url` | string | URL to the created request |
|
||||
|
||||
@@ -120,12 +146,33 @@ Get a single service request from Jira Service Management
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
|
||||
| `expand` | string | No | Comma-separated fields to expand: participant, status, sla, requestType, serviceDesk, attachment, comment, action |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `issueId` | string | Jira issue ID |
|
||||
| `issueKey` | string | Issue key \(e.g., SD-123\) |
|
||||
| `requestTypeId` | string | Request type ID |
|
||||
| `serviceDeskId` | string | Service desk ID |
|
||||
| `createdDate` | json | Creation date with iso8601, friendly, epochMillis |
|
||||
| `currentStatus` | object | Current request status |
|
||||
| ↳ `status` | string | Status name |
|
||||
| ↳ `statusCategory` | string | Status category \(NEW, INDETERMINATE, DONE\) |
|
||||
| ↳ `statusDate` | json | Status change date with iso8601, friendly, epochMillis |
|
||||
| `reporter` | object | Reporter user details |
|
||||
| ↳ `accountId` | string | Atlassian account ID |
|
||||
| ↳ `displayName` | string | User display name |
|
||||
| ↳ `emailAddress` | string | User email address |
|
||||
| ↳ `active` | boolean | Whether the account is active |
|
||||
| `requestFieldValues` | array | Request field values |
|
||||
| ↳ `fieldId` | string | Field identifier |
|
||||
| ↳ `label` | string | Human-readable field label |
|
||||
| ↳ `value` | json | Field value |
|
||||
| ↳ `renderedValue` | json | HTML-rendered field value |
|
||||
| `url` | string | URL to the request |
|
||||
| `request` | json | The service request object |
|
||||
|
||||
### `jsm_get_requests`
|
||||
@@ -139,9 +186,11 @@ Get multiple service requests from Jira Service Management
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `serviceDeskId` | string | No | Filter by service desk ID \(e.g., "1", "2"\) |
|
||||
| `requestOwnership` | string | No | Filter by ownership: OWNED_REQUESTS, PARTICIPATED_REQUESTS, ORGANIZATION, ALL_REQUESTS |
|
||||
| `requestStatus` | string | No | Filter by status: OPEN, CLOSED, ALL |
|
||||
| `requestOwnership` | string | No | Filter by ownership: OWNED_REQUESTS, PARTICIPATED_REQUESTS, APPROVER, ALL_REQUESTS |
|
||||
| `requestStatus` | string | No | Filter by status: OPEN_REQUESTS, CLOSED_REQUESTS, ALL_REQUESTS |
|
||||
| `requestTypeId` | string | No | Filter by request type ID |
|
||||
| `searchTerm` | string | No | Search term to filter requests \(e.g., "password reset", "laptop"\) |
|
||||
| `expand` | string | No | Comma-separated fields to expand: participant, status, sla, requestType, serviceDesk, attachment, comment, action |
|
||||
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||
|
||||
@@ -150,8 +199,27 @@ Get multiple service requests from Jira Service Management
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `requests` | json | Array of service requests |
|
||||
| `total` | number | Total number of requests |
|
||||
| `requests` | array | List of service requests |
|
||||
| ↳ `issueId` | string | Jira issue ID |
|
||||
| ↳ `issueKey` | string | Issue key \(e.g., SD-123\) |
|
||||
| ↳ `requestTypeId` | string | Request type ID |
|
||||
| ↳ `serviceDeskId` | string | Service desk ID |
|
||||
| ↳ `createdDate` | json | Creation date with iso8601, friendly, epochMillis |
|
||||
| ↳ `currentStatus` | object | Current request status |
|
||||
| ↳ `status` | string | Status name |
|
||||
| ↳ `statusCategory` | string | Status category \(NEW, INDETERMINATE, DONE\) |
|
||||
| ↳ `statusDate` | json | Status change date with iso8601, friendly, epochMillis |
|
||||
| ↳ `reporter` | object | Reporter user details |
|
||||
| ↳ `accountId` | string | Atlassian account ID |
|
||||
| ↳ `displayName` | string | User display name |
|
||||
| ↳ `emailAddress` | string | User email address |
|
||||
| ↳ `active` | boolean | Whether the account is active |
|
||||
| ↳ `requestFieldValues` | array | Request field values |
|
||||
| ↳ `fieldId` | string | Field identifier |
|
||||
| ↳ `label` | string | Human-readable field label |
|
||||
| ↳ `value` | json | Field value |
|
||||
| ↳ `renderedValue` | json | HTML-rendered field value |
|
||||
| `total` | number | Total number of requests in current page |
|
||||
| `isLastPage` | boolean | Whether this is the last page |
|
||||
|
||||
### `jsm_add_comment`
|
||||
@@ -177,6 +245,12 @@ Add a comment (public or internal) to a service request in Jira Service Manageme
|
||||
| `commentId` | string | Created comment ID |
|
||||
| `body` | string | Comment body text |
|
||||
| `isPublic` | boolean | Whether the comment is public |
|
||||
| `author` | object | Comment author |
|
||||
| ↳ `accountId` | string | Atlassian account ID |
|
||||
| ↳ `displayName` | string | User display name |
|
||||
| ↳ `emailAddress` | string | User email address |
|
||||
| ↳ `active` | boolean | Whether the account is active |
|
||||
| `createdDate` | json | Comment creation date with iso8601, friendly, epochMillis |
|
||||
| `success` | boolean | Whether the comment was added successfully |
|
||||
|
||||
### `jsm_get_comments`
|
||||
@@ -192,6 +266,7 @@ Get comments for a service request in Jira Service Management
|
||||
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
|
||||
| `isPublic` | boolean | No | Filter to only public comments \(true/false\) |
|
||||
| `internal` | boolean | No | Filter to only internal comments \(true/false\) |
|
||||
| `expand` | string | No | Comma-separated fields to expand: renderedBody, attachment |
|
||||
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||
|
||||
@@ -201,7 +276,17 @@ Get comments for a service request in Jira Service Management
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `issueIdOrKey` | string | Issue ID or key |
|
||||
| `comments` | json | Array of comments |
|
||||
| `comments` | array | List of comments |
|
||||
| ↳ `id` | string | Comment ID |
|
||||
| ↳ `body` | string | Comment body text |
|
||||
| ↳ `public` | boolean | Whether the comment is public |
|
||||
| ↳ `author` | object | Comment author |
|
||||
| ↳ `accountId` | string | Atlassian account ID |
|
||||
| ↳ `displayName` | string | User display name |
|
||||
| ↳ `emailAddress` | string | User email address |
|
||||
| ↳ `active` | boolean | Whether the account is active |
|
||||
| ↳ `created` | json | Creation date with iso8601, friendly, epochMillis |
|
||||
| ↳ `renderedBody` | json | HTML-rendered comment body \(when expand=renderedBody\) |
|
||||
| `total` | number | Total number of comments |
|
||||
| `isLastPage` | boolean | Whether this is the last page |
|
||||
|
||||
@@ -225,7 +310,12 @@ Get customers for a service desk in Jira Service Management
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `customers` | json | Array of customers |
|
||||
| `customers` | array | List of customers |
|
||||
| ↳ `accountId` | string | Atlassian account ID |
|
||||
| ↳ `displayName` | string | Display name |
|
||||
| ↳ `emailAddress` | string | Email address |
|
||||
| ↳ `active` | boolean | Whether the account is active |
|
||||
| ↳ `timeZone` | string | User timezone |
|
||||
| `total` | number | Total number of customers |
|
||||
| `isLastPage` | boolean | Whether this is the last page |
|
||||
|
||||
@@ -240,7 +330,8 @@ Add customers to a service desk in Jira Service Management
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) |
|
||||
| `emails` | string | Yes | Comma-separated email addresses to add as customers |
|
||||
| `accountIds` | string | No | Comma-separated Atlassian account IDs to add as customers |
|
||||
| `emails` | string | No | Comma-separated email addresses to add as customers |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -269,7 +360,9 @@ Get organizations for a service desk in Jira Service Management
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `organizations` | json | Array of organizations |
|
||||
| `organizations` | array | List of organizations |
|
||||
| ↳ `id` | string | Organization ID |
|
||||
| ↳ `name` | string | Organization name |
|
||||
| `total` | number | Total number of organizations |
|
||||
| `isLastPage` | boolean | Whether this is the last page |
|
||||
|
||||
@@ -336,7 +429,12 @@ Get queues for a service desk in Jira Service Management
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `queues` | json | Array of queues |
|
||||
| `queues` | array | List of queues |
|
||||
| ↳ `id` | string | Queue ID |
|
||||
| ↳ `name` | string | Queue name |
|
||||
| ↳ `jql` | string | JQL filter for the queue |
|
||||
| ↳ `fields` | json | Fields displayed in the queue |
|
||||
| ↳ `issueCount` | number | Number of issues in the queue |
|
||||
| `total` | number | Total number of queues |
|
||||
| `isLastPage` | boolean | Whether this is the last page |
|
||||
|
||||
@@ -360,7 +458,11 @@ Get SLA information for a service request in Jira Service Management
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `issueIdOrKey` | string | Issue ID or key |
|
||||
| `slas` | json | Array of SLA information |
|
||||
| `slas` | array | List of SLA metrics |
|
||||
| ↳ `id` | string | SLA metric ID |
|
||||
| ↳ `name` | string | SLA metric name |
|
||||
| ↳ `completedCycles` | json | Completed SLA cycles with startTime, stopTime, breachTime, breached, goalDuration, elapsedTime, remainingTime \(each time as DateDTO, durations as DurationDTO\) |
|
||||
| ↳ `ongoingCycle` | json | Ongoing SLA cycle with startTime, breachTime, breached, paused, withinCalendarHours, goalDuration, elapsedTime, remainingTime |
|
||||
| `total` | number | Total number of SLAs |
|
||||
| `isLastPage` | boolean | Whether this is the last page |
|
||||
|
||||
@@ -375,6 +477,8 @@ Get available transitions for a service request in Jira Service Management
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `issueIdOrKey` | string | Yes | Issue ID or key \(e.g., SD-123\) |
|
||||
| `start` | number | No | Start index for pagination \(e.g., 0, 50, 100\) |
|
||||
| `limit` | number | No | Maximum results to return \(e.g., 10, 25, 50\) |
|
||||
|
||||
#### Output
|
||||
|
||||
@@ -382,7 +486,11 @@ Get available transitions for a service request in Jira Service Management
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `issueIdOrKey` | string | Issue ID or key |
|
||||
| `transitions` | json | Array of available transitions |
|
||||
| `transitions` | array | List of available transitions |
|
||||
| ↳ `id` | string | Transition ID |
|
||||
| ↳ `name` | string | Transition name |
|
||||
| `total` | number | Total number of transitions |
|
||||
| `isLastPage` | boolean | Whether this is the last page |
|
||||
|
||||
### `jsm_transition_request`
|
||||
|
||||
@@ -427,7 +535,11 @@ Get participants for a request in Jira Service Management
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `issueIdOrKey` | string | Issue ID or key |
|
||||
| `participants` | json | Array of participants |
|
||||
| `participants` | array | List of participants |
|
||||
| ↳ `accountId` | string | Atlassian account ID |
|
||||
| ↳ `displayName` | string | Display name |
|
||||
| ↳ `emailAddress` | string | Email address |
|
||||
| ↳ `active` | boolean | Whether the account is active |
|
||||
| `total` | number | Total number of participants |
|
||||
| `isLastPage` | boolean | Whether this is the last page |
|
||||
|
||||
@@ -450,7 +562,11 @@ Add participants to a request in Jira Service Management
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `issueIdOrKey` | string | Issue ID or key |
|
||||
| `participants` | json | Array of added participants |
|
||||
| `participants` | array | List of added participants |
|
||||
| ↳ `accountId` | string | Atlassian account ID |
|
||||
| ↳ `displayName` | string | Display name |
|
||||
| ↳ `emailAddress` | string | Email address |
|
||||
| ↳ `active` | boolean | Whether the account is active |
|
||||
| `success` | boolean | Whether the operation succeeded |
|
||||
|
||||
### `jsm_get_approvals`
|
||||
@@ -473,7 +589,20 @@ Get approvals for a request in Jira Service Management
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `issueIdOrKey` | string | Issue ID or key |
|
||||
| `approvals` | json | Array of approvals |
|
||||
| `approvals` | array | List of approvals |
|
||||
| ↳ `id` | string | Approval ID |
|
||||
| ↳ `name` | string | Approval description |
|
||||
| ↳ `finalDecision` | string | Final decision: pending, approved, or declined |
|
||||
| ↳ `canAnswerApproval` | boolean | Whether current user can respond |
|
||||
| ↳ `approvers` | array | List of approvers with their decisions |
|
||||
| ↳ `approver` | object | Approver user details |
|
||||
| ↳ `accountId` | string | Atlassian account ID |
|
||||
| ↳ `displayName` | string | User display name |
|
||||
| ↳ `emailAddress` | string | User email address |
|
||||
| ↳ `active` | boolean | Whether the account is active |
|
||||
| ↳ `approverDecision` | string | Decision: pending, approved, or declined |
|
||||
| ↳ `createdDate` | json | Creation date |
|
||||
| ↳ `completedDate` | json | Completion date |
|
||||
| `total` | number | Total number of approvals |
|
||||
| `isLastPage` | boolean | Whether this is the last page |
|
||||
|
||||
@@ -499,6 +628,53 @@ Approve or decline an approval request in Jira Service Management
|
||||
| `issueIdOrKey` | string | Issue ID or key |
|
||||
| `approvalId` | string | Approval ID |
|
||||
| `decision` | string | Decision made \(approve/decline\) |
|
||||
| `id` | string | Approval ID from response |
|
||||
| `name` | string | Approval description |
|
||||
| `finalDecision` | string | Final approval decision: pending, approved, or declined |
|
||||
| `canAnswerApproval` | boolean | Whether the current user can still respond |
|
||||
| `approvers` | array | Updated list of approvers with decisions |
|
||||
| ↳ `approver` | object | Approver user details |
|
||||
| ↳ `accountId` | string | Approver account ID |
|
||||
| ↳ `displayName` | string | Approver display name |
|
||||
| ↳ `emailAddress` | string | Approver email |
|
||||
| ↳ `active` | boolean | Whether the account is active |
|
||||
| ↳ `approverDecision` | string | Individual approver decision |
|
||||
| `createdDate` | json | Approval creation date |
|
||||
| `completedDate` | json | Approval completion date |
|
||||
| `approval` | json | The approval object |
|
||||
| `success` | boolean | Whether the operation succeeded |
|
||||
|
||||
### `jsm_get_request_type_fields`
|
||||
|
||||
Get the fields required to create a request of a specific type in Jira Service Management
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `domain` | string | Yes | Your Jira domain \(e.g., yourcompany.atlassian.net\) |
|
||||
| `cloudId` | string | No | Jira Cloud ID for the instance |
|
||||
| `serviceDeskId` | string | Yes | Service Desk ID \(e.g., "1", "2"\) |
|
||||
| `requestTypeId` | string | Yes | Request Type ID \(e.g., "10", "15"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `ts` | string | Timestamp of the operation |
|
||||
| `serviceDeskId` | string | Service desk ID |
|
||||
| `requestTypeId` | string | Request type ID |
|
||||
| `canAddRequestParticipants` | boolean | Whether participants can be added to requests of this type |
|
||||
| `canRaiseOnBehalfOf` | boolean | Whether requests can be raised on behalf of another user |
|
||||
| `requestTypeFields` | array | List of fields for this request type |
|
||||
| ↳ `fieldId` | string | Field identifier \(e.g., summary, description, customfield_10010\) |
|
||||
| ↳ `name` | string | Human-readable field name |
|
||||
| ↳ `description` | string | Help text for the field |
|
||||
| ↳ `required` | boolean | Whether the field is required |
|
||||
| ↳ `visible` | boolean | Whether the field is visible |
|
||||
| ↳ `validValues` | json | Allowed values for select fields |
|
||||
| ↳ `presetValues` | json | Pre-populated values |
|
||||
| ↳ `defaultValues` | json | Default values for the field |
|
||||
| ↳ `jiraSchema` | json | Jira field schema with type, system, custom, customId |
|
||||
|
||||
|
||||
|
||||
@@ -76,6 +76,7 @@
|
||||
"neo4j",
|
||||
"notion",
|
||||
"onedrive",
|
||||
"onepassword",
|
||||
"openai",
|
||||
"outlook",
|
||||
"parallel_ai",
|
||||
|
||||
260
apps/docs/content/docs/en/tools/onepassword.mdx
Normal file
260
apps/docs/content/docs/en/tools/onepassword.mdx
Normal file
@@ -0,0 +1,260 @@
|
||||
---
|
||||
title: 1Password
|
||||
description: Manage secrets and items in 1Password vaults
|
||||
---
|
||||
|
||||
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
||||
|
||||
<BlockInfoCard
|
||||
type="onepassword"
|
||||
color="#E0E0E0"
|
||||
/>
|
||||
|
||||
{/* MANUAL-CONTENT-START:intro */}
|
||||
[1Password](https://1password.com) is a widely trusted password manager and secrets vault solution, allowing individuals and teams to securely store, access, and share passwords, API credentials, and sensitive information. With robust encryption, granular access controls, and seamless syncing across devices, 1Password supports teams and organizations in managing secrets efficiently and securely.
|
||||
|
||||
The [1Password Connect API](https://developer.1password.com/docs/connect/) allows programmatic access to vaults and items within an organization's 1Password account. This integration in Sim lets you automate secret retrieval, onboarding workflows, secret rotation, vault audits, and more, all in a secure and auditable manner.
|
||||
|
||||
With 1Password in your Sim workflow, you can:
|
||||
|
||||
- **List, search, and retrieve vaults**: Access metadata or browse available vaults for organizing secrets by project or purpose
|
||||
- **Fetch items and secrets**: Get credentials, API keys, or custom secrets in real time to power your workflows securely
|
||||
- **Create, update, or delete secrets**: Automate secret management, provisioning, and rotation for enhanced security practices
|
||||
- **Integrate with CI/CD and automation**: Fetch credentials or tokens only when needed, reducing manual work and reducing risk
|
||||
- **Ensure access controls**: Leverage role-based access and fine-grained permissions to control which agents or users can access specific secrets
|
||||
|
||||
By connecting Sim with 1Password, you empower your agents to securely manage secrets, reduce manual overhead, and maintain best practices for security automation, incident response, and DevOps workflows—all while ensuring secrets never leave a controlled environment.
|
||||
{/* MANUAL-CONTENT-END */}
|
||||
|
||||
|
||||
## Usage Instructions
|
||||
|
||||
Access and manage secrets stored in 1Password vaults using the Connect API or Service Account SDK. List vaults, retrieve items with their fields and secrets, create new items, update existing ones, delete items, and resolve secret references.
|
||||
|
||||
|
||||
|
||||
## Tools
|
||||
|
||||
### `onepassword_list_vaults`
|
||||
|
||||
List all vaults accessible by the Connect token or Service Account
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `connectionMode` | string | No | Connection mode: "service_account" or "connect" |
|
||||
| `serviceAccountToken` | string | No | 1Password Service Account token \(for Service Account mode\) |
|
||||
| `apiKey` | string | No | 1Password Connect API token \(for Connect Server mode\) |
|
||||
| `serverUrl` | string | No | 1Password Connect server URL \(for Connect Server mode\) |
|
||||
| `filter` | string | No | SCIM filter expression \(e.g., name eq "My Vault"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `vaults` | array | List of accessible vaults |
|
||||
| ↳ `id` | string | Vault ID |
|
||||
| ↳ `name` | string | Vault name |
|
||||
| ↳ `description` | string | Vault description |
|
||||
| ↳ `attributeVersion` | number | Vault attribute version |
|
||||
| ↳ `contentVersion` | number | Vault content version |
|
||||
| ↳ `type` | string | Vault type \(USER_CREATED, PERSONAL, EVERYONE, TRANSFER\) |
|
||||
| ↳ `createdAt` | string | Creation timestamp |
|
||||
| ↳ `updatedAt` | string | Last update timestamp |
|
||||
|
||||
### `onepassword_get_vault`
|
||||
|
||||
Get details of a specific vault by ID
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `connectionMode` | string | No | Connection mode: "service_account" or "connect" |
|
||||
| `serviceAccountToken` | string | No | 1Password Service Account token \(for Service Account mode\) |
|
||||
| `apiKey` | string | No | 1Password Connect API token \(for Connect Server mode\) |
|
||||
| `serverUrl` | string | No | 1Password Connect server URL \(for Connect Server mode\) |
|
||||
| `vaultId` | string | Yes | The vault UUID |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `id` | string | Vault ID |
|
||||
| `name` | string | Vault name |
|
||||
| `description` | string | Vault description |
|
||||
| `attributeVersion` | number | Vault attribute version |
|
||||
| `contentVersion` | number | Vault content version |
|
||||
| `items` | number | Number of items in the vault |
|
||||
| `type` | string | Vault type \(USER_CREATED, PERSONAL, EVERYONE, TRANSFER\) |
|
||||
| `createdAt` | string | Creation timestamp |
|
||||
| `updatedAt` | string | Last update timestamp |
|
||||
|
||||
### `onepassword_list_items`
|
||||
|
||||
List items in a vault. Returns summaries without field values.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `connectionMode` | string | No | Connection mode: "service_account" or "connect" |
|
||||
| `serviceAccountToken` | string | No | 1Password Service Account token \(for Service Account mode\) |
|
||||
| `apiKey` | string | No | 1Password Connect API token \(for Connect Server mode\) |
|
||||
| `serverUrl` | string | No | 1Password Connect server URL \(for Connect Server mode\) |
|
||||
| `vaultId` | string | Yes | The vault UUID to list items from |
|
||||
| `filter` | string | No | SCIM filter expression \(e.g., title eq "API Key" or tag eq "production"\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `items` | array | List of items in the vault \(summaries without field values\) |
|
||||
| ↳ `id` | string | Item ID |
|
||||
| ↳ `title` | string | Item title |
|
||||
| ↳ `vault` | object | Vault reference |
|
||||
| ↳ `id` | string | Vault ID |
|
||||
| ↳ `category` | string | Item category \(e.g., LOGIN, API_CREDENTIAL\) |
|
||||
| ↳ `urls` | array | URLs associated with the item |
|
||||
| ↳ `href` | string | URL |
|
||||
| ↳ `label` | string | URL label |
|
||||
| ↳ `primary` | boolean | Whether this is the primary URL |
|
||||
| ↳ `favorite` | boolean | Whether the item is favorited |
|
||||
| ↳ `tags` | array | Item tags |
|
||||
| ↳ `version` | number | Item version number |
|
||||
| ↳ `state` | string | Item state \(ARCHIVED or DELETED\) |
|
||||
| ↳ `createdAt` | string | Creation timestamp |
|
||||
| ↳ `updatedAt` | string | Last update timestamp |
|
||||
| ↳ `lastEditedBy` | string | ID of the last editor |
|
||||
|
||||
### `onepassword_get_item`
|
||||
|
||||
Get full details of an item including all fields and secrets
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `connectionMode` | string | No | Connection mode: "service_account" or "connect" |
|
||||
| `serviceAccountToken` | string | No | 1Password Service Account token \(for Service Account mode\) |
|
||||
| `apiKey` | string | No | 1Password Connect API token \(for Connect Server mode\) |
|
||||
| `serverUrl` | string | No | 1Password Connect server URL \(for Connect Server mode\) |
|
||||
| `vaultId` | string | Yes | The vault UUID |
|
||||
| `itemId` | string | Yes | The item UUID to retrieve |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `response` | json | Operation response data |
|
||||
|
||||
### `onepassword_create_item`
|
||||
|
||||
Create a new item in a vault
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `connectionMode` | string | No | Connection mode: "service_account" or "connect" |
|
||||
| `serviceAccountToken` | string | No | 1Password Service Account token \(for Service Account mode\) |
|
||||
| `apiKey` | string | No | 1Password Connect API token \(for Connect Server mode\) |
|
||||
| `serverUrl` | string | No | 1Password Connect server URL \(for Connect Server mode\) |
|
||||
| `vaultId` | string | Yes | The vault UUID to create the item in |
|
||||
| `category` | string | Yes | Item category \(e.g., LOGIN, PASSWORD, API_CREDENTIAL, SECURE_NOTE, SERVER, DATABASE\) |
|
||||
| `title` | string | No | Item title |
|
||||
| `tags` | string | No | Comma-separated list of tags |
|
||||
| `fields` | string | No | JSON array of field objects \(e.g., \[\{"label":"username","value":"admin","type":"STRING","purpose":"USERNAME"\}\]\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `response` | json | Operation response data |
|
||||
|
||||
### `onepassword_replace_item`
|
||||
|
||||
Replace an entire item with new data (full update)
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `connectionMode` | string | No | Connection mode: "service_account" or "connect" |
|
||||
| `serviceAccountToken` | string | No | 1Password Service Account token \(for Service Account mode\) |
|
||||
| `apiKey` | string | No | 1Password Connect API token \(for Connect Server mode\) |
|
||||
| `serverUrl` | string | No | 1Password Connect server URL \(for Connect Server mode\) |
|
||||
| `vaultId` | string | Yes | The vault UUID |
|
||||
| `itemId` | string | Yes | The item UUID to replace |
|
||||
| `item` | string | Yes | JSON object representing the full item \(e.g., \{"vault":\{"id":"..."\},"category":"LOGIN","title":"My Item","fields":\[...\]\}\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `response` | json | Operation response data |
|
||||
|
||||
### `onepassword_update_item`
|
||||
|
||||
Update an existing item using JSON Patch operations (RFC6902)
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `connectionMode` | string | No | Connection mode: "service_account" or "connect" |
|
||||
| `serviceAccountToken` | string | No | 1Password Service Account token \(for Service Account mode\) |
|
||||
| `apiKey` | string | No | 1Password Connect API token \(for Connect Server mode\) |
|
||||
| `serverUrl` | string | No | 1Password Connect server URL \(for Connect Server mode\) |
|
||||
| `vaultId` | string | Yes | The vault UUID |
|
||||
| `itemId` | string | Yes | The item UUID to update |
|
||||
| `operations` | string | Yes | JSON array of RFC6902 patch operations \(e.g., \[\{"op":"replace","path":"/title","value":"New Title"\}\]\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `response` | json | Operation response data |
|
||||
|
||||
### `onepassword_delete_item`
|
||||
|
||||
Delete an item from a vault
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `connectionMode` | string | No | Connection mode: "service_account" or "connect" |
|
||||
| `serviceAccountToken` | string | No | 1Password Service Account token \(for Service Account mode\) |
|
||||
| `apiKey` | string | No | 1Password Connect API token \(for Connect Server mode\) |
|
||||
| `serverUrl` | string | No | 1Password Connect server URL \(for Connect Server mode\) |
|
||||
| `vaultId` | string | Yes | The vault UUID |
|
||||
| `itemId` | string | Yes | The item UUID to delete |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `success` | boolean | Whether the item was successfully deleted |
|
||||
|
||||
### `onepassword_resolve_secret`
|
||||
|
||||
Resolve a secret reference (op://vault/item/field) to its value. Service Account mode only.
|
||||
|
||||
#### Input
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `connectionMode` | string | No | Connection mode: must be "service_account" for this operation |
|
||||
| `serviceAccountToken` | string | Yes | 1Password Service Account token |
|
||||
| `secretReference` | string | Yes | Secret reference URI \(e.g., op://vault-name/item-name/field-name or op://vault-name/item-name/section-name/field-name\) |
|
||||
|
||||
#### Output
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
| `value` | string | The resolved secret value |
|
||||
| `reference` | string | The original secret reference URI |
|
||||
|
||||
|
||||
Reference in New Issue
Block a user