Authentication Specification

We support authentication based on API Key and OAuth2. We will be requiring below information. API Key

Email ID (email_id)
API Key (api_key)
Jira Domain (jira_domain)

OAuth2

Client Id (client_id)
Client Secret (client_secret)
Scopes (scopes)
Refresh Tokens (refresh_token)
Jira Domain (jira_domain)

Supported Models

Mapping

Attachment

Key	Value	Description
`id`	`attachmentId`	The ID of the attachment
`file_name`	`filename`	The filename of the attachment
`content_type`	`mimeType`	The MIME type of the attachment
`uploaded_by`	`{ id: author.key, username: author.displayName }`	The user who uploaded the attachment
`created_at`	`created`	The date and time the attachment was created

Collection

Key	Value	Description
`id`	`id`	The ID of the collection
`name`	`name`	The name of the collection
`type`	`projectTypeKey`	The type of the collection

User

Key	Value	Description
`id`	`accountId`	The ID of the user
`name`	`displayName`	The display name of the user
`avatar`	`avatarUrls['48x48']`	The avatar URL of the user

Ticket

Key	Value	Description
`id`	`id`	The ID of the ticket
`name`	`fields.summary`	The summary of the ticket
`collection_id`	`fields.project.id`	The ID of the collection the ticket belongs to
`description`	`fields.description`	The description of the ticket
`status`	`fields.status.name`	The status of the ticket
`created_at`	`fields.created`	The date and time the ticket was created
`updated_at`	`fields.updated`	The date and time the ticket was last updated
`created_by`	`fields.creator.displayName`	The username of the user who created the ticket
`type`	`fields.issuetype.name`	The type of the ticket
`assignees`	`{ id: fields.assignee?.accountId, username: fields.assignee?.displayName }`	The assignees of the ticket
`ticket_url`	`self`	The URL of the ticket
`parent_id`	`fields.parent?.id`	The ID of the parent ticket
`priority`	`fields.priority.name`	The priority of the ticket
`due_date`	`fields.duedate`	The due date of the ticket
`tags`	`labels(id, displayName)`	The tags of the ticket

Comment

Key	Value	Description
`id`	`id`	The ID of the comment
`ticket_id`	`collection_id(internal)	The ID of the ticket the comment belongs to
`body`	`body`	The body text of the comment
`created_by_id`	`author.accountId`	The ID of the user who created the comment
`created_by`	`{ id: author.accountId, username: author.displayName }`	The user who created the comment
`is_private`	`jsdPublic`	Whether the comment is public or private
`created_at`	`created`	The date and time the comment was created
`updated_at`	`updated`	The date and time the comment was last updated

Github Get Collections