Authentication Specification

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

API Key

  1. API Key (api_key)
  2. Organisation identifier (org)

OAuth2

  1. Client Id (client_id)
  2. Client Secret (client_secret)
  3. Scopes (scopes)
  4. Refresh Tokens (refresh_token)
  5. Organisation identifier (org)

Supported Models

Mapping

Collection

KeyValueDescription
ididThe ID of the project
ticket_idissue_urlThe ID of the ticket, extracted from the issue URL
bodybodyThe body text of the project
created_by_iduser.idThe ID of the user who created the project
created_byuser.loginThe username of the user who created the project
created_atcreated_atThe date and time the project was created
updated_atupdated_atThe date and time the project was last updated

User

KeyValueDescription
idloginThe ID of the user
nameloginThe name of the user
avataravatar_urlThe avatar URL of the user

Team

KeyValueDescription
ididThe ID of the team
namenameThe name of the team
descriptiondescriptionThe description of the team

Ticket

KeyValueDescription
idnumberThe ID of the ticket
nametitleThe title of the ticket
collection_idcollection_id(internal)The ID of the collection the ticket belongs to
descriptionbodyThe description of the ticket
statusstateThe status of the ticket
created_atcreated_atThe date and time the ticket was created
updated_atupdated_atThe date and time the ticket was last updated
created_byuser.loginThe username of the user who created the ticket
typepull_requestThe type of the ticket (pull request or issue)
assigneesassignees(id, login)The assignees of the ticket
ticket_urlurlThe URL of the ticket
tagslabels(id, name)The tags of the ticket

Tag

KeyValueDescription
ididThe ID of the tag
namenameThe name of the tag
descriptiondescriptionThe description of the tag
colorcolorThe color of the tag