Kubis1982.Atlassian.Jira.RestClient.v3 1.8453.1

Atlassian Jira REST Client

Strongly-typed REST client for Atlassian Jira Cloud API v3, automatically generated using Microsoft Kiota from the official OpenAPI specification.

Package Information

• Package ID: Kubis1982.Atlassian.Jira.RestClient.v3
• NuGet:
• Current Version: 1.8453.0

Features

• ✅ Fully typed C# client for Jira Cloud API v3
• ✅ Generated from official OpenAPI specification
• ✅ Built with Microsoft Kiota code generation tool
• ✅ Support for .NET 10.0+

Installation

Via NuGet Package Manager

dotnet add package Kubis1982.Atlassian.Jira.RestClient.v3

Via Package Manager Console

Install-Package Kubis1982.Atlassian.Jira.RestClient.v3

Via .csproj

<ItemGroup>
    <PackageReference Include="Kubis1982.Atlassian.Jira.RestClient.v3" Version="1.8458.0" />
</ItemGroup>

Usage

Creating a Client Instance

To use the Jira REST client, you need to create an instance with proper authentication:

Basic Authentication (Email + API Token) - Recommended

using Kubis1982.Atlassian.Jira.RestClient;
using Kubis1982.Atlassian.Jira.RestClient.Models;
using Kubis1982.Atlassian.RestClient;
using Microsoft.Kiota.Abstractions.Serialization;

// Configuration
var domain = "your-company"; // without .atlassian.net
var email = "your-email@company.com";
var apiToken = "your-api-token"; // Generate from https://id.atlassian.com/manage-profile/security/api-tokens

// Create authentication provider
var basicAuthProvider = new BasicAuthProvider(email, apiToken);

// Initialize client
var jiraClient = JiraRestClient.Create(domain, basicAuthProvider);

Note: The BasicAuthProvider is provided by the Kubis1982.Atlassian.RestClient package and is automatically included as a dependency.

Example Operations

// Get current user information
var myself = await jiraClient.Rest.Api.Three.Myself.GetAsync();
Console.WriteLine($"User: {myself?.DisplayName} ({myself?.EmailAddress})");

// Get all projects
var projects = await jiraClient.Rest.Api.Three.Project.GetAsync();
foreach (var project in projects ?? [])
{
    Console.WriteLine($"Project: {project.Key} - {project.Name}");
}

// Search for issues
var searchResults = await jiraClient.Rest.Api.Three.Search.GetAsync(config =>
{
    config.QueryParameters.Jql = "project = 'YOUR_PROJECT' AND status = 'In Progress'";
});

foreach (var issue in searchResults?.Issues ?? [])
{
    Console.WriteLine($"- {issue.Key}: {issue.Fields?.Summary}");
}

// Get specific issue
var issue = await jiraClient.Rest.Api.Three.Issue["PROJECT-123"].GetAsync();
Console.WriteLine($"Issue: {issue?.Key} - {issue?.Fields?.Summary}");

// Add worklog with ADF (Atlassian Document Format) comment
try
{
    var worklog = await jiraClient.Rest.Api.Three.Issue["PROJECT-123"].Worklog.PostAsync(new Worklog
    {
        TimeSpentSeconds = 60,
        Started = DateTimeOffset.UtcNow,
        Comment = new UntypedObject(new Dictionary<string, UntypedNode>
        {
            ["type"] = new UntypedString("doc"),
            ["version"] = new UntypedInteger(1),
            ["content"] = new UntypedArray([
                new UntypedObject(new Dictionary<string, UntypedNode>
                {
                    ["type"] = new UntypedString("paragraph"),
                    ["content"] = new UntypedArray([
                        new UntypedObject(new Dictionary<string, UntypedNode>
                        {
                            ["type"] = new UntypedString("text"),
                            ["text"] = new UntypedString("Completed task")
                        })
                    ])
                })
            ])
        })
    });

    Console.WriteLine($"Worklog created with ID: {worklog?.Id}");
}
catch (Exception ex)
{
    Console.WriteLine($"Error creating worklog: {ex.Message}");
}

// Create an issue
var createIssueRequest = new IssueUpdateDetails
{
    Fields = new Dictionary<string, object>
    {
        ["project"] = new { key = "YOUR_PROJECT" },
        ["summary"] = "New issue summary",
        ["description"] = new UntypedObject(new Dictionary<string, UntypedNode>
        {
            ["type"] = new UntypedString("doc"),
            ["version"] = new UntypedInteger(1),
            ["content"] = new UntypedArray([
                new UntypedObject(new Dictionary<string, UntypedNode>
                {
                    ["type"] = new UntypedString("paragraph"),
                    ["content"] = new UntypedArray([
                        new UntypedObject(new Dictionary<string, UntypedNode>
                        {
                            ["type"] = new UntypedString("text"),
                            ["text"] = new UntypedString("Issue description")
                        })
                    ])
                })
            ])
        }),
        ["issuetype"] = new { name = "Task" }
    }
};
var newIssue = await jiraClient.Rest.Api.Three.Issue.PostAsync(createIssueRequest);
Console.WriteLine($"Created issue: {newIssue?.Key}");

Custom DateTime Serialization

The client automatically handles Jira's specific date-time format (2026-04-18T09:04:00.1182+0000) through the Kubis1982.Atlassian.RestClient package. No additional configuration is needed when using JiraRestClient.Create().

OpenAPI Specification

This client is generated from the official Jira Cloud OpenAPI specification:

📄 Specification URL:

https://dac-static.atlassian.com/cloud/jira/platform/swagger-v3.v3.json?_v=1.8458.0

Repository

For more information, visit the Atlassian REST Client repository.

License

MIT - See LICENSE for details.