Python Jira

https://jira.readthedocs.io/en/latest/
Admin
This documents the `jira` python package, a Python library designed to ease the use of the Jira REST...
Tokens:13,779
Snippets:117
Trust Score:9.6
Update:4 months ago
Show doc for...
Tokens:
Raw
### JIRA.create_board()

Source: https://jira.readthedocs.io/en/latest

Creates a new board.

```APIDOC
## JIRA.create_board(name, type, filter_id, project_id_or_key)

### Description
Creates a new board.

### Method
POST (assumed)

### Endpoint
/rest/agile/1.0/board

### Parameters
#### Request Body
- **name** (string) - Required - The name of the board.
- **type** (string) - Required - The type of the board (e.g., 'scrum', 'kanban').
- **filterId** (integer) - Optional - The ID of the filter to use for the board.
- **projectIdOrKey** (string) - Optional - The ID or key of the project to associate with the board.
```

--------------------------------

### JIRA.backup()

Source: https://jira.readthedocs.io/en/latest

Initiates a backup of the Jira instance. This is an administrative task.

```APIDOC
## JIRA.backup(exclude_jira_history)

### Description
Initiates a backup of the Jira instance. This is an administrative task.

### Method
POST (assumed)

### Endpoint
/rest/api/2/backup

### Parameters
#### Query Parameters
- **excludeJiraHistory** (boolean) - Optional - If true, excludes Jira history from the backup.
```

--------------------------------

### JIRA.create_project()

Source: https://jira.readthedocs.io/en/latest

Creates a new project in Jira.

```APIDOC
## JIRA.create_project(key, name, project_type_key, project_template_key, description, lead, lead_avatar_url, assignee_type, avatar_id, issue_security_scheme, permission_scheme, notification_scheme, workflow_scheme)

### Description
Creates a new project in Jira.

### Method
POST (assumed)

### Endpoint
/rest/api/2/project

### Parameters
#### Request Body
- **key** (string) - Required - The project key.
- **name** (string) - Required - The project name.
- **projectTypeKey** (string) - Required - The type of the project (e.g., 'software', 'service_desk').
- **projectTemplateKey** (string) - Required - The key of the project template to use.
- **description** (string) - Optional - A description for the project.
- **lead** (string) - Optional - The username of the project lead.
- **leadAvatarUrl** (string) - Optional - The URL of the project lead's avatar.
- **assigneeType** (string) - Optional - The default assignee for issues (e.g., 'PROJECT_LEAD', 'UNASSIGNED').
- **avatarId** (integer) - Optional - The ID of the avatar to use for the project.
- **issueSecurityScheme** (integer) - Optional - The ID of the issue security scheme.
- **permissionScheme** (integer) - Optional - The ID of the permission scheme.
- **notificationScheme** (integer) - Optional - The ID of the notification scheme.
- **workflowScheme** (integer) - Optional - The ID of the workflow scheme.
```

--------------------------------

### JIRA.templates()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of available project templates for creating new projects.

```APIDOC
## JIRA.templates()

### Description
Retrieves a list of available project templates for creating new projects.

### Method
GET (assumed)

### Endpoint
/rest/api/2/project/template

### Parameters
None
```

--------------------------------

### JIRA.backup_download()

Source: https://jira.readthedocs.io/en/latest

Downloads the completed Jira backup file.

```APIDOC
## JIRA.backup_download()

### Description
Downloads the completed Jira backup file.

### Method
GET (assumed)

### Endpoint
/rest/api/2/backup/download

### Parameters
None
```

--------------------------------

### JIRA.project_components()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all components for a specific project.

```APIDOC
## JIRA.project_components(project_id_or_key)

### Description
Retrieves a list of all components for a specific project.

### Method
GET (assumed)

### Endpoint
/rest/api/2/project/{projectIdOrKey}/component

### Parameters
#### Path Parameters
- **projectIdOrKey** (string) - Required - The ID or key of the project.
```

--------------------------------

### JIRA.create_version()

Source: https://jira.readthedocs.io/en/latest

Creates a new version for a project.

```APIDOC
## JIRA.create_version(project_id_or_key, name, description, release_date, user_release_date)

### Description
Creates a new version for a project.

### Method
POST (assumed)

### Endpoint
/rest/api/2/version

### Parameters
#### Request Body
- **projectIdOrKey** (string) - Required - The ID or key of the project.
- **name** (string) - Required - The name of the new version.
- **description** (string) - Optional - A description for the version.
- **releaseDate** (string) - Optional - The release date of the version (YYYY-MM-DD).
- **userReleaseDate** (string) - Optional - The user-specified release date of the version.
```

--------------------------------

### JIRA.boards()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all boards accessible by the current user.

```APIDOC
## JIRA.boards()

### Description
Retrieves a list of all boards accessible by the current user.

### Method
GET (assumed)

### Endpoint
/rest/agile/1.0/board

### Parameters
None
```

--------------------------------

### JIRA.project()

Source: https://jira.readthedocs.io/en/latest

Retrieves details for a specific project.

```APIDOC
## JIRA.project(project_id_or_key)

### Description
Retrieves details for a specific project.

### Method
GET (assumed)

### Endpoint
/rest/api/2/project/{projectIdOrKey}

### Parameters
#### Path Parameters
- **projectIdOrKey** (string) - Required - The ID or key of the project.
```

--------------------------------

### JIRA.version()

Source: https://jira.readthedocs.io/en/latest

Retrieves details for a specific project version.

```APIDOC
## JIRA.version(version_id)

### Description
Retrieves details for a specific project version.

### Method
GET (assumed)

### Endpoint
/rest/api/2/version/{versionId}

### Parameters
#### Path Parameters
- **versionId** (string) - Required - The ID of the version to retrieve.
```

--------------------------------

### JIRA.screens()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all screens available in Jira.

```APIDOC
## JIRA.screens()

### Description
Retrieves a list of all screens available in Jira.

### Method
GET (assumed)

### Endpoint
/rest/api/2/screens

### Parameters
None
```

--------------------------------

### JIRA.projects()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all projects accessible by the current user.

```APIDOC
## JIRA.projects()

### Description
Retrieves a list of all projects accessible by the current user.

### Method
GET (assumed)

### Endpoint
/rest/api/2/project

### Parameters
None

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the project.
- **key** (string) - The project key.
- **name** (string) - The name of the project.
- **projectTypeKey** (string) - The type of the project (e.g., 'software', 'service_desk').
- **avatarUrls** (object) - URLs for different sizes of the project avatar.
- **self** (string) - The URL of the project resource.
```

--------------------------------

### JIRA.permissionschemes()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all permission schemes available in Jira.

```APIDOC
## JIRA.permissionschemes()

### Description
Retrieves a list of all permission schemes available in Jira.

### Method
GET (assumed)

### Endpoint
/rest/api/2/permissionscheme

### Parameters
None
```

--------------------------------

### JIRA.priorities()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all available priorities in Jira.

```APIDOC
## JIRA.priorities()

### Description
Retrieves a list of all available priorities in Jira.

### Method
GET (assumed)

### Endpoint
/rest/api/2/priority

### Parameters
None

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the priority.
- **name** (string) - The name of the priority.
- **iconUrl** (string) - The URL of the icon associated with the priority.
- **statusColor** (string) - The color associated with the priority.
```

--------------------------------

### JIRA.workflows()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all workflows available in Jira.

```APIDOC
## JIRA.workflows()

### Description
Retrieves a list of all workflows available in Jira.

### Method
GET (assumed)

### Endpoint
/rest/api/2/workflow

### Parameters
None
```

--------------------------------

### JIRA.project_versions()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all versions for a specific project.

```APIDOC
## JIRA.project_versions(project_id_or_key)

### Description
Retrieves a list of all versions for a specific project.

### Method
GET (assumed)

### Endpoint
/rest/api/2/project/{projectIdOrKey}/version

### Parameters
#### Path Parameters
- **projectIdOrKey** (string) - Required - The ID or key of the project.
```

--------------------------------

### JIRA.resolutions()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all available resolutions in Jira.

```APIDOC
## JIRA.resolutions()

### Description
Retrieves a list of all available resolutions in Jira.

### Method
GET (assumed)

### Endpoint
/rest/api/2/resolution

### Parameters
None

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the resolution.
- **name** (string) - The name of the resolution.
- **description** (string) - A description of the resolution.
```

--------------------------------

### JIRA.server_info()

Source: https://jira.readthedocs.io/en/latest

Retrieves information about the Jira server.

```APIDOC
## JIRA.server_info()

### Description
Retrieves information about the Jira server.

### Method
GET (assumed)

### Endpoint
/rest/api/2/server/info

### Parameters
None

### Response
#### Success Response (200)
- **baseUrl** (string) - The base URL of the Jira server.
- **version** (string) - The version of Jira.
- **deploymentType** (string) - The deployment type (e.g., 'Server', 'Data Center').
```

--------------------------------

### jira.client module functions

Source: https://jira.readthedocs.io/en/latest

Provides access to core Jira API functionalities, including initializing connections and handling experimental features.

```APIDOC
## Functions in jira.client

### `cloud_api()`

Initializes a connection to the Jira Cloud API.

### `experimental_atlassian_api()`

Provides access to experimental Atlassian API features.

### `translate_resource_args()`

Translates resource arguments for API calls.
```

--------------------------------

### JIRA.create_sprint()

Source: https://jira.readthedocs.io/en/latest

Creates a new sprint for a given board.

```APIDOC
## JIRA.create_sprint(board_id, name, startDate, endDate, goal)

### Description
Creates a new sprint for a given board.

### Method
POST (assumed)

### Endpoint
/rest/agile/1.0/sprint

### Parameters
#### Request Body
- **boardId** (string) - Required - The ID of the board.
- **name** (string) - Required - The name of the sprint.
- **startDate** (string) - Optional - The start date of the sprint (ISO 8601 format).
- **endDate** (string) - Optional - The end date of the sprint (ISO 8601 format).
- **goal** (string) - Optional - The goal of the sprint.
```

--------------------------------

### JIRA.statuses()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all available statuses in Jira.

```APIDOC
## JIRA.statuses()

### Description
Retrieves a list of all available statuses in Jira.

### Method
GET (assumed)

### Endpoint
/rest/api/2/status

### Parameters
None

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the status.
- **name** (string) - The name of the status.
- **description** (string) - A description of the status.
- **statusCategory** (object) - The status category (e.g., 'To Do', 'In Progress', 'Done').
```

--------------------------------

### JIRA.projectcategories()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all project categories.

```APIDOC
## JIRA.projectcategories()

### Description
Retrieves a list of all project categories.

### Method
GET (assumed)

### Endpoint
/rest/api/2/projectCategory

### Parameters
None
```

--------------------------------

### QshGenerator Class

Source: https://jira.readthedocs.io/en/latest

Handles the generation of QSH (Query String Hash) for certain API requests.

```APIDOC
## QshGenerator Class

### `__init__()`

Initializes a new QshGenerator instance.
```

--------------------------------

### JIRA.notificationschemes()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all notification schemes available in Jira.

```APIDOC
## JIRA.notificationschemes()

### Description
Retrieves a list of all notification schemes available in Jira.

### Method
GET (assumed)

### Endpoint
/rest/api/2/notificationscheme

### Parameters
None
```

--------------------------------

### TokenAuth Class

Source: https://jira.readthedocs.io/en/latest

Handles token-based authentication for Jira.

```APIDOC
## TokenAuth Class

### `__init__()`

Initializes a new TokenAuth instance.
```

--------------------------------

### JIRA.avatars()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all available system avatars.

```APIDOC
## JIRA.avatars()

### Description
Retrieves a list of all available system avatars.

### Method
GET (assumed)

### Endpoint
/rest/api/2/avatar

### Parameters
None
```

--------------------------------

### JIRA.add_user()

Source: https://jira.readthedocs.io/en/latest

Adds a new user to Jira. This is an administrative operation.

```APIDOC
## JIRA.add_user(username, password, email, display_name, notification_scheme)

### Description
Adds a new user to Jira. This is an administrative operation.

### Method
POST (assumed)

### Endpoint
/rest/api/2/user

### Parameters
#### Request Body
- **username** (string) - Required - The username for the new user.
- **password** (string) - Required - The password for the new user.
- **email** (string) - Required - The email address of the new user.
- **displayName** (string) - Optional - The display name for the new user.
- **notificationScheme** (integer) - Optional - The ID of the notification scheme to associate with the user.
```

--------------------------------

### JIRA.move_to_backlog()

Source: https://jira.readthedocs.io/en/latest

Moves issues from a sprint back to the backlog.

```APIDOC
## JIRA.move_to_backlog(issue_ids)

### Description
Moves issues from a sprint back to the backlog.

### Method
POST (assumed)

### Endpoint
/rest/agile/1.0/sprint/backlog

### Parameters
#### Request Body
- **issueIds** (array) - Required - A list of issue IDs to move to the backlog.
```

--------------------------------

### JIRA.search_issues()

Source: https://jira.readthedocs.io/en/latest

Searches for issues using JQL (Jira Query Language).

```APIDOC
## JIRA.search_issues(jql_query, start_at, max_results, fields, expand)

### Description
Searches for issues using JQL (Jira Query Language).

### Method
GET (assumed)

### Endpoint
/rest/api/2/search

### Parameters
#### Query Parameters
- **jqlQuery** (string) - Required - The JQL query string.
- **startAt** (integer) - Optional - The starting index of the search results.
- **maxResults** (integer) - Optional - The maximum number of results to return.
- **fields** (string) - Optional - A comma-separated list of fields to include in the results.
- **expand** (string) - Optional - A comma-separated list of fields to expand in the results.
```

--------------------------------

### JIRA.sprints()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of sprints for a given board.

```APIDOC
## JIRA.sprints(board_id)

### Description
Retrieves a list of sprints for a given board.

### Method
GET (assumed)

### Endpoint
/rest/agile/1.0/board/{boardId}/sprint

### Parameters
#### Path Parameters
- **boardId** (string) - Required - The ID of the board.
```

--------------------------------

### JIRA.get_igrid()

Source: https://jira.readthedocs.io/en/latest

Retrieves information related to the Jira grid (likely for UI or configuration purposes).

```APIDOC
## JIRA.get_igrid()

### Description
Retrieves information related to the Jira grid (likely for UI or configuration purposes).

### Method
GET (assumed)

### Endpoint
/rest/api/2/configuration/igrid

### Parameters
None
```

--------------------------------

### JIRA.myself()

Source: https://jira.readthedocs.io/en/latest

Retrieves information about the currently authenticated user.

```APIDOC
## JIRA.myself()

### Description
Retrieves information about the currently authenticated user.

### Method
GET (assumed)

### Endpoint
/rest/api/2/myself

### Parameters
None

### Response
#### Success Response (200)
- **self** (string) - The URL of the user resource.
- **name** (string) - The username.
- **displayName** (string) - The display name of the user.
- **emailAddress** (string) - The email address of the user.
```

--------------------------------

### JIRA.get_project_version_by_name()

Source: https://jira.readthedocs.io/en/latest

Retrieves a specific version of a project by its name.

```APIDOC
## JIRA.get_project_version_by_name(project_id_or_key, version_name)

### Description
Retrieves a specific version of a project by its name.

### Method
GET (assumed)

### Endpoint
/rest/api/2/project/{projectIdOrKey}/version?name={versionName}

### Parameters
#### Path Parameters
- **projectIdOrKey** (string) - Required - The ID or key of the project.
#### Query Parameters
- **versionName** (string) - Required - The name of the version to retrieve.
```

--------------------------------

### JIRA.workflowscheme()

Source: https://jira.readthedocs.io/en/latest

Retrieves details for a specific workflow scheme.

```APIDOC
## JIRA.workflowscheme(workflow_scheme_id)

### Description
Retrieves details for a specific workflow scheme.

### Method
GET (assumed)

### Endpoint
/rest/api/2/workflowscheme/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the workflow scheme to retrieve.
```

--------------------------------

### Authentication Methods

Source: https://jira.readthedocs.io/en/latest

Details various methods for authenticating with Jira, including cookie-based, basic, OAuth, and token authentication.

```APIDOC
## Authentication Methods

### Cookie Based Authentication

Uses cookies for session management.

### HTTP BASIC Authentication

Supports authentication using username and password, or username and API token.

- **(username, password)**
- **(username, api_token)**

### OAuth

Supports OAuth for authentication.

### Token Auth

Supports token-based authentication for both Jira Cloud and Jira Self Hosted (including Jira Server/Data Center).

### Kerberos

Supports Kerberos for authentication.
```

--------------------------------

### JIRA.sprint_info()

Source: https://jira.readthedocs.io/en/latest

Retrieves detailed information about a specific sprint.

```APIDOC
## JIRA.sprint_info(sprint_id)

### Description
Retrieves detailed information about a specific sprint.

### Method
GET (assumed)

### Endpoint
/rest/agile/1.0/sprint/{sprintId}

### Parameters
#### Path Parameters
- **sprintId** (string) - Required - The ID of the sprint.
```

--------------------------------

### JIRA.backup_progress()

Source: https://jira.readthedocs.io/en/latest

Retrieves the progress of an ongoing Jira backup.

```APIDOC
## JIRA.backup_progress()

### Description
Retrieves the progress of an ongoing Jira backup.

### Method
GET (assumed)

### Endpoint
/rest/api/2/backup/progress

### Parameters
None
```

--------------------------------

### JIRA.project_roles()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all project roles available in Jira.

```APIDOC
## JIRA.project_roles(project_id_or_key)

### Description
Retrieves a list of all project roles available in Jira.

### Method
GET (assumed)

### Endpoint
/rest/api/2/project/{projectIdOrKey}/role

### Parameters
#### Path Parameters
- **projectIdOrKey** (string) - Required - The ID or key of the project.
```

--------------------------------

### JIRA.create_temp_project_avatar()

Source: https://jira.readthedocs.io/en/latest

Creates a temporary avatar for a project. This is usually an intermediate step before confirming the avatar.

```APIDOC
## JIRA.create_temp_project_avatar(project_id_or_key, avatar_image)

### Description
Creates a temporary avatar for a project. This is usually an intermediate step before confirming the avatar.

### Method
POST (assumed)

### Endpoint
/rest/api/2/project/{projectIdOrKey}/avatar

### Parameters
#### Path Parameters
- **projectIdOrKey** (string) - Required - The ID or key of the project.
#### Request Body
- **avatar_image** (file) - Required - The image file for the avatar.
```

--------------------------------

### JIRA.issuesecurityschemes()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all issue security schemes available in Jira.

```APIDOC
## JIRA.issuesecurityschemes()

### Description
Retrieves a list of all issue security schemes available in Jira.

### Method
GET (assumed)

### Endpoint
/rest/api/2/issuesecurityscheme

### Parameters
None
```

--------------------------------

### JIRA.rank()

Source: https://jira.readthedocs.io/en/latest

Ranks issues within a board or sprint.

```APIDOC
## JIRA.rank(issue_ids, order_before, order_after, rank_before_issue, rank_after_issue)

### Description
Ranks issues within a board or sprint.

### Method
PUT (assumed)

### Endpoint
/rest/agile/1.0/jql

### Parameters
#### Request Body
- **issueIds** (array) - Required - A list of issue IDs to rank.
- **orderBefore** (string) - Optional - The ID of the issue to place the ranked issues before.
- **orderAfter** (string) - Optional - The ID of the issue to place the ranked issues after.
- **rankBeforeIssue** (string) - Optional - The ID of the issue to rank before.
- **rankAfterIssue** (string) - Optional - The ID of the issue to rank after.
```

--------------------------------

### JIRA.move_version()

Source: https://jira.readthedocs.io/en/latest

Moves a project version to a different position in the version list.

```APIDOC
## JIRA.move_version(version_id, position)

### Description
Moves a project version to a different position in the version list.

### Method
PUT (assumed)

### Endpoint
/rest/api/2/version/{versionId}/move

### Parameters
#### Path Parameters
- **versionId** (string) - Required - The ID of the version to move.
#### Request Body
- **position** (string) - Required - The position to move the version to (e.g., 'First', 'Last', 'After <versionId>', 'Before <versionId>').
```

--------------------------------

### JIRA Class Methods

Source: https://jira.readthedocs.io/en/latest

The main class for interacting with Jira, offering a comprehensive set of methods for managing various Jira entities.

```APIDOC
## JIRA Class

### `__init__(...)`

Initializes a new JIRA client instance.

### `client_info()`

Retrieves information about the Jira client.

### `find()`

Finds Jira issues based on specified criteria.

### `async_do()`

Performs asynchronous operations.

### `application_properties()`

Retrieves application properties.

### `set_application_property()`

Sets an application property.

### `applicationlinks()`

Retrieves application links.

### `attachment()`

Retrieves attachment information.

### `attachment_meta()`

Retrieves metadata for attachments.

### `add_attachment()`

Adds an attachment to an issue.

### `delete_attachment()`

Deletes an attachment.

### `component()`

Retrieves component information.

### `create_component()`

Creates a new component.

### `component_count_related_issues()`

Counts issues related to a component.

### `delete_component()`

Deletes a component.

### `custom_field_option()`

Retrieves custom field option information.

### `dashboards()`

Retrieves a list of dashboards.

### `dashboard()`

Retrieves a specific dashboard.

### `create_dashboard()`

Creates a new dashboard.

### `copy_dashboard()`

Copies an existing dashboard.

### `update_dashboard_automatic_refresh_minutes()`

Updates the automatic refresh interval for a dashboard.

### `dashboard_item_property_keys()`

Retrieves property keys for a dashboard item.

### `dashboard_item_property()`

Retrieves a property for a dashboard item.

### `set_dashboard_item_property()`

Sets a property for a dashboard item.

### `dashboard_gadgets()`

Retrieves gadgets for a dashboard.

### `all_dashboard_gadgets()`

Retrieves all gadgets available for dashboards.

### `add_gadget_to_dashboard()`

Adds a gadget to a dashboard.

### `fields()`

Retrieves available fields.

### `filter()`

Retrieves filter information.

### `favourite_filters()`

Retrieves favorite filters.

### `create_filter()`

Creates a new filter.

### `update_filter()`

Updates an existing filter.

### `group()`

Retrieves group information.

### `groups()`

Retrieves a list of groups.

### `group_members()`

Retrieves members of a group.

### `add_group()`

Adds a new group.

### `remove_group()`

Removes a group.

### `issue()`

Retrieves issue information.

### `create_issue()`

Creates a new issue.

### `create_issues()`

Creates multiple issues.

### `supports_service_desk()`

Checks if service desk is supported.

### `create_customer()`

Creates a new customer.

### `service_desks()`

Retrieves a list of service desks.

### `service_desk()`

Retrieves a specific service desk.

### `create_customer_request()`

Creates a customer request.

### `createmeta_issuetypes()`

Retrieves issue type metadata for creation.

### `createmeta_fieldtypes()`

Retrieves field type metadata for creation.

### `createmeta()`

Retrieves metadata for issue creation.

### `assign_issue()`

Assigns an issue to a user.

### `comments()`

Retrieves comments for an issue.

### `comment()`

Retrieves a specific comment.

### `add_comment()`

Adds a comment to an issue.

### `editmeta()`

Retrieves edit metadata for an issue.

### `remote_links()`

Retrieves remote links for an issue.

### `remote_link()`

Retrieves a specific remote link.

### `add_remote_link()`

Adds a remote link to an issue.

### `add_simple_link()`

Adds a simple link to an issue.

### `transitions()`

Retrieves available transitions for an issue.

### `find_transitionid_by_name()`

Finds a transition ID by its name.

### `transition_issue()`

Transitions an issue.

### `votes()`

Retrieves vote information for an issue.

### `project_issue_security_level_scheme()`

Retrieves the issue security scheme for a project.

### `project_notification_scheme()`

Retrieves the notification scheme for a project.

### `project_permissionscheme()`

Retrieves the permission scheme for a project.

### `project_priority_scheme()`

Retrieves the priority scheme for a project.

### `project_workflow_scheme()`

Retrieves the workflow scheme for a project.

### `add_vote()`

Adds a vote to an issue.

### `remove_vote()`

Removes a vote from an issue.

### `watchers()`

Retrieves watchers for an issue.

### `add_watcher()`

Adds a watcher to an issue.

### `remove_watcher()`

Removes a watcher from an issue.

### `worklogs()`

Retrieves worklogs for an issue.

### `worklog()`

Retrieves a specific worklog.

### `add_worklog()`

Adds a worklog to an issue.

### `issue_properties()`

Retrieves properties for an issue.

### `issue_property()`

Retrieves a specific property for an issue.

### `add_issue_property()`

Adds a property to an issue.

### `create_issue_link()`

Creates a link between issues.

### `delete_issue_link()`

Deletes a link between issues.

### `issue_link()`

Retrieves information about an issue link.
```

--------------------------------

### JIRA.backup_complete()

Source: https://jira.readthedocs.io/en/latest

Checks if a Jira backup has completed.

```APIDOC
## JIRA.backup_complete()

### Description
Checks if a Jira backup has completed.

### Method
GET (assumed)

### Endpoint
/rest/api/2/backup/complete

### Parameters
None
```

--------------------------------

### JIRA.session()

Source: https://jira.readthedocs.io/en/latest

Retrieves information about the current user's session.

```APIDOC
## JIRA.session()

### Description
Retrieves information about the current user's session.

### Method
GET (assumed)

### Endpoint
/rest/auth/1/session

### Parameters
None

### Response
#### Success Response (200)
- **name** (string) - The session name.
- **value** (string) - The session ID.
- **expires** (string) - The session expiration date.
```

--------------------------------

### JIRA.statuscategories()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all available status categories in Jira.

```APIDOC
## JIRA.statuscategories()

### Description
Retrieves a list of all available status categories in Jira.

### Method
GET (assumed)

### Endpoint
/rest/api/2/statuscategory

### Parameters
None

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the status category.
- **name** (string) - The name of the status category (e.g., 'To Do', 'In Progress', 'Done').
- **description** (string) - A description of the status category.
- **key** (string) - A key representing the status category.
```

--------------------------------

### JIRA.priority()

Source: https://jira.readthedocs.io/en/latest

Retrieves a specific priority by its ID.

```APIDOC
## JIRA.priority(priority_id)

### Description
Retrieves a specific priority by its ID.

### Method
GET (assumed)

### Endpoint
/rest/api/2/priority/{priorityId}

### Parameters
#### Path Parameters
- **priorityId** (string) - Required - The ID of the priority to retrieve.
```

--------------------------------

### JIRA.my_permissions()

Source: https://jira.readthedocs.io/en/latest

Retrieves the permissions of the currently authenticated user.

```APIDOC
## JIRA.my_permissions()

### Description
Retrieves the permissions of the currently authenticated user.

### Method
GET (assumed)

### Endpoint
/rest/api/2/mypermissions

### Parameters
None

### Response
#### Success Response (200)
- **permissions** (object) - An object containing the user's permissions.
```

--------------------------------

### JIRA.search_assignable_users_for_projects()

Source: https://jira.readthedocs.io/en/latest

Searches for users who can be assigned issues within specified projects.

```APIDOC
## JIRA.search_assignable_users_for_projects(project_keys, query)

### Description
Searches for users who can be assigned issues within specified projects.

### Method
GET (assumed)

### Endpoint
/rest/api/2/user/assignable/project

### Parameters
#### Query Parameters
- **projectKeys** (string) - Required - A comma-separated list of project keys.
- **query** (string) - Optional - The search query string for user names or email addresses.
```

--------------------------------

### JIRA.project_avatars()

Source: https://jira.readthedocs.io/en/latest

Retrieves all avatars available for a specific project.

```APIDOC
## JIRA.project_avatars(project_id_or_key)

### Description
Retrieves all avatars available for a specific project.

### Method
GET (assumed)

### Endpoint
/rest/api/2/project/{projectIdOrKey}/avatars

### Parameters
#### Path Parameters
- **projectIdOrKey** (string) - Required - The ID or key of the project.
```

--------------------------------

### JIRA.confirm_project_avatar()

Source: https://jira.readthedocs.io/en/latest

Confirms the temporary avatar for a project, making it the active avatar.

```APIDOC
## JIRA.confirm_project_avatar(project_id_or_key, avatar_id)

### Description
Confirms the temporary avatar for a project, making it the active avatar.

### Method
PUT (assumed)

### Endpoint
/rest/api/2/project/{projectIdOrKey}/avatar/{avatarId}

### Parameters
#### Path Parameters
- **projectIdOrKey** (string) - Required - The ID or key of the project.
- **avatarId** (string) - Required - The ID of the temporary avatar to confirm.
```

--------------------------------

### JIRA.role()

Source: https://jira.readthedocs.io/en/latest

Retrieves details for a specific project role by its ID.

```APIDOC
## JIRA.role(role_id)

### Description
Retrieves details for a specific project role by its ID.

### Method
GET (assumed)

### Endpoint
/rest/api/2/role/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the project role to retrieve.
```

--------------------------------

### JIRA.search_users()

Source: https://jira.readthedocs.io/en/latest

Searches for users based on various criteria.

```APIDOC
## JIRA.search_users(query, start_at, max_results, include_active, include_inactive)

### Description
Searches for users based on various criteria.

### Method
GET (assumed)

### Endpoint
/rest/api/2/user/search

### Parameters
#### Query Parameters
- **query** (string) - Required - The search query string (e.g., username, email, display name).
- **startAt** (integer) - Optional - The starting index of the search results.
- **maxResults** (integer) - Optional - The maximum number of results to return.
- **includeActive** (boolean) - Optional - Whether to include active users.
- **includeInactive** (boolean) - Optional - Whether to include inactive users.
```

--------------------------------

### JIRA.current_user()

Source: https://jira.readthedocs.io/en/latest

Retrieves information about the currently authenticated user. Alias for `myself()`.

```APIDOC
## JIRA.current_user()

### Description
Retrieves information about the currently authenticated user. Alias for `myself()`.

### Method
GET (assumed)

### Endpoint
/rest/api/2/myself

### Parameters
None
```

--------------------------------

### JIRA.create_temp_user_avatar()

Source: https://jira.readthedocs.io/en/latest

Creates a temporary avatar for a user. This is usually an intermediate step before confirming the avatar.

```APIDOC
## JIRA.create_temp_user_avatar(username, avatar_image)

### Description
Creates a temporary avatar for a user. This is usually an intermediate step before confirming the avatar.

### Method
POST (assumed)

### Endpoint
/rest/api/2/user/{username}/avatar

### Parameters
#### Path Parameters
- **username** (string) - Required - The username of the user.
#### Request Body
- **avatar_image** (file) - Required - The image file for the avatar.
```

--------------------------------

### JIRA.delete_project()

Source: https://jira.readthedocs.io/en/latest

Deletes a project. This is a destructive operation and typically requires administrative privileges.

```APIDOC
## JIRA.delete_project(project_id_or_key)

### Description
Deletes a project. This is a destructive operation and typically requires administrative privileges.

### Method
DELETE (assumed)

### Endpoint
/rest/api/2/project/{projectIdOrKey}

### Parameters
#### Path Parameters
- **projectIdOrKey** (string) - Required - The ID or key of the project to delete.
```

--------------------------------

### JIRA.user()

Source: https://jira.readthedocs.io/en/latest

Retrieves information about a specific user.

```APIDOC
## JIRA.user(username)

### Description
Retrieves information about a specific user.

### Method
GET (assumed)

### Endpoint
/rest/api/2/user

### Parameters
#### Query Parameters
- **username** (string) - Required - The username of the user to retrieve.
```

--------------------------------

### ResultList Class

Source: https://jira.readthedocs.io/en/latest

Represents a list of results returned from Jira queries.

```APIDOC
## ResultList Class

### `__init__()`

Initializes a new ResultList instance.
```

--------------------------------

### JIRA.request_types()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all available request types in Jira Service Management.

```APIDOC
## JIRA.request_types()

### Description
Retrieves a list of all available request types in Jira Service Management.

### Method
GET (assumed)

### Endpoint
/rest/servicedeskapi/1/requesttype

### Parameters
None

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the request type.
- **name** (string) - The name of the request type.
- **description** (string) - A description of the request type.
- **portalName** (string) - The name displayed on the customer portal.
- **helpText** (string) - Help text associated with the request type.
```

--------------------------------

### JIRA.delete_screen()

Source: https://jira.readthedocs.io/en/latest

Deletes a screen. This is an administrative operation.

```APIDOC
## JIRA.delete_screen(screen_id)

### Description
Deletes a screen. This is an administrative operation.

### Method
DELETE (assumed)

### Endpoint
/rest/api/2/screens/{screenId}

### Parameters
#### Path Parameters
- **screenId** (string) - Required - The ID of the screen to delete.
```

--------------------------------

### JIRA.security_level()

Source: https://jira.readthedocs.io/en/latest

Retrieves details for a specific security level.

```APIDOC
## JIRA.security_level(security_level_id)

### Description
Retrieves details for a specific security level.

### Method
GET (assumed)

### Endpoint
/rest/api/2/securityLevel/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the security level to retrieve.
```

--------------------------------

### JIRA.sprints_by_name()

Source: https://jira.readthedocs.io/en/latest

Retrieves sprints by their name, potentially across multiple boards.

```APIDOC
## JIRA.sprints_by_name(sprint_name)

### Description
Retrieves sprints by their name, potentially across multiple boards.

### Method
GET (assumed)

### Endpoint
/rest/agile/1.0/sprint?search={sprintName}

### Parameters
#### Query Parameters
- **sprintName** (string) - Required - The name of the sprint to search for.
```

--------------------------------

### JIRA.project_role()

Source: https://jira.readthedocs.io/en/latest

Retrieves details for a specific project role within a project.

```APIDOC
## JIRA.project_role(project_id_or_key, role_id)

### Description
Retrieves details for a specific project role within a project.

### Method
GET (assumed)

### Endpoint
/rest/api/2/project/{projectIdOrKey}/role/{id}

### Parameters
#### Path Parameters
- **projectIdOrKey** (string) - Required - The ID or key of the project.
- **id** (string) - Required - The ID of the project role.
```

--------------------------------

### JIRA.issue_types()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all available issue types across Jira.

```APIDOC
## JIRA.issue_types()

### Description
Retrieves a list of all available issue types across Jira.

### Method
GET (assumed)

### Endpoint
/rest/api/2/issuetype

### Parameters
None

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the issue type.
- **name** (string) - The name of the issue type.
- **description** (string) - A description of the issue type.
- **subtask** (boolean) - Indicates if the issue type is a subtask.
- **avatarId** (integer) - The ID of the avatar associated with the issue type.
- **self** (string) - The URL of the issue type resource.
```

--------------------------------

### JIRA.search_allowed_users_for_issue()

Source: https://jira.readthedocs.io/en/latest

Searches for users who are allowed to be assigned to a specific issue.

```APIDOC
## JIRA.search_allowed_users_for_issue(issue_key, query)

### Description
Searches for users who are allowed to be assigned to a specific issue.

### Method
GET (assumed)

### Endpoint
/rest/api/2/user/permission/search

### Parameters
#### Query Parameters
- **issueKey** (string) - Required - The key of the issue.
- **query** (string) - Optional - The search query string for user names or email addresses.
```

--------------------------------

### JIRA.search_assignable_users_for_issues()

Source: https://jira.readthedocs.io/en/latest

Searches for users who can be assigned to a specific issue.

```APIDOC
## JIRA.search_assignable_users_for_issues(issue_key, query)

### Description
Searches for users who can be assigned to a specific issue.

### Method
GET (assumed)

### Endpoint
/rest/api/2/user/assignable/issue

### Parameters
#### Query Parameters
- **issueKey** (string) - Required - The key of the issue.
- **query** (string) - Optional - The search query string for user names or email addresses.
```

--------------------------------

### JIRA.project_issue_types()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of issue types available for a specific project.

```APIDOC
## JIRA.project_issue_types(project_id)

### Description
Retrieves a list of issue types available for a specific project.

### Method
GET (assumed)

### Endpoint
/rest/api/2/project/{projectIdOrKey}/issuetypes

### Parameters
#### Path Parameters
- **projectIdOrKey** (string) - Required - The ID or key of the project.
```

--------------------------------

### JIRA.resolution()

Source: https://jira.readthedocs.io/en/latest

Retrieves a specific resolution by its ID.

```APIDOC
## JIRA.resolution(resolution_id)

### Description
Retrieves a specific resolution by its ID.

### Method
GET (assumed)

### Endpoint
/rest/api/2/resolution/{resolutionId}

### Parameters
#### Path Parameters
- **resolutionId** (string) - Required - The ID of the resolution to retrieve.
```

--------------------------------

### JIRA.delete_board()

Source: https://jira.readthedocs.io/en/latest

Deletes a board. This is a destructive operation.

```APIDOC
## JIRA.delete_board(board_id)

### Description
Deletes a board. This is a destructive operation.

### Method
DELETE (assumed)

### Endpoint
/rest/agile/1.0/board/{boardId}

### Parameters
#### Path Parameters
- **boardId** (string) - Required - The ID of the board to delete.
```

--------------------------------

### JIRA.status()

Source: https://jira.readthedocs.io/en/latest

Retrieves a specific status by its ID.

```APIDOC
## JIRA.status(status_id)

### Description
Retrieves a specific status by its ID.

### Method
GET (assumed)

### Endpoint
/rest/api/2/status/{statusId}

### Parameters
#### Path Parameters
- **statusId** (string) - Required - The ID of the status to retrieve.
```

--------------------------------

### JIRA.update_sprint()

Source: https://jira.readthedocs.io/en/latest

Updates an existing sprint's details.

```APIDOC
## JIRA.update_sprint(sprint_id, name, startDate, endDate, originBoardId, goal)

### Description
Updates an existing sprint's details.

### Method
PUT (assumed)

### Endpoint
/rest/agile/1.0/sprint/{sprintId}

### Parameters
#### Path Parameters
- **sprintId** (string) - Required - The ID of the sprint to update.
#### Request Body
- **name** (string) - Optional - The new name for the sprint.
- **startDate** (string) - Optional - The new start date for the sprint (ISO 8601 format).
- **endDate** (string) - Optional - The new end date for the sprint (ISO 8601 format).
- **originBoardId** (integer) - Optional - The ID of the board the sprint belongs to.
- **goal** (string) - Optional - The goal of the sprint.
```

--------------------------------

### JIRA.add_issues_to_epic()

Source: https://jira.readthedocs.io/en/latest

Adds existing issues to an epic.

```APIDOC
## JIRA.add_issues_to_epic(epic_id, issue_ids)

### Description
Adds existing issues to an epic.

### Method
POST (assumed)

### Endpoint
/rest/agile/1.0/epic/{epicId}/issue

### Parameters
#### Path Parameters
- **epicId** (string) - Required - The ID of the epic.
#### Request Body
- **issueIds** (array) - Required - A list of issue IDs to add to the epic.
```

--------------------------------

### JIRA.issue_type_schemes()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all issue type schemes available in Jira.

```APIDOC
## JIRA.issue_type_schemes()

### Description
Retrieves a list of all issue type schemes available in Jira.

### Method
GET (assumed)

### Endpoint
/rest/api/2/issuetypescheme

### Parameters
None
```

--------------------------------

### JIRA.sprint()

Source: https://jira.readthedocs.io/en/latest

Retrieves a specific sprint by its ID. Alias for `sprint_info()`.

```APIDOC
## JIRA.sprint(sprint_id)

### Description
Retrieves a specific sprint by its ID. Alias for `sprint_info()`.

### Method
GET (assumed)

### Endpoint
/rest/agile/1.0/sprint/{sprintId}

### Parameters
#### Path Parameters
- **sprintId** (string) - Required - The ID of the sprint.
```

--------------------------------

### JIRA.issue_link_types()

Source: https://jira.readthedocs.io/en/latest

Retrieves a list of all available issue link types in Jira.

```APIDOC
## JIRA.issue_link_types()

### Description
Retrieves a list of all available issue link types in Jira.

### Method
GET (assumed)

### Endpoint
/rest/api/2/issueLinkType

### Parameters
None

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the issue link type.
- **name** (string) - The name of the issue link type.
- **inward** (string) - Description of the inward link.
- **outward** (string) - Description of the outward link.
- **self** (string) - The URL of the issue link type resource.
```

--------------------------------

### JIRA.pin_comment()

Source: https://jira.readthedocs.io/en/latest

Pins a comment to an issue, making it a pinned comment.

```APIDOC
## JIRA.pin_comment(issue_key, comment_id)

### Description
Pins a comment to an issue, making it a pinned comment.

### Method
POST (assumed)

### Endpoint
/rest/api/2/issue/{issueIdOrKey}/remotelink

### Parameters
#### Path Parameters
- **issueIdOrKey** (string) - Required - The ID or key of the issue.
#### Request Body
- **commentId** (string) - Required - The ID of the comment to pin.
```

--------------------------------

### JiraCookieAuth Class

Source: https://jira.readthedocs.io/en/latest

Handles cookie-based authentication for Jira.

```APIDOC
## JiraCookieAuth Class

### `__init__()`

Initializes a new JiraCookieAuth instance.

### `cookies`

Property to access the authentication cookies.

### `init_session()`

Initializes the authentication session.

### `handle_401()`

Handles 401 Unauthorized responses.

### `process_original_request()`

Processes the original request during authentication.

### `update_cookies()`

Updates the authentication cookies.

### `send_request()`

Sends a request using cookie authentication.
```

--------------------------------

### JIRA.kill_websudo()

Source: https://jira.readthedocs.io/en/latest

Kills the WebSudo authentication for the current user.

```APIDOC
## JIRA.kill_websudo()

### Description
Kills the WebSudo authentication for the current user.

### Method
DELETE (assumed)

### Endpoint
/rest/auth/1/websudo

### Parameters
None
```
Tokens:
Raw