JIRA Rest API Login с использованием С#

Ответ 1

Для базовой аутентификации вам необходимо отправить имя пользователя и пароль в base64-кодировку. Рекомендации можно найти в примерах API на странице разработчика atlassians: https://developer.atlassian.com/display/JIRADEV/JIRA+REST+API+Example+-+Basic+Authentication, если вы делаете это на С#, вам нужно отправьте закодированные данные в заголовке в следующем формате:

"Авторизация: Основные [ENCODED CREDENTIALS]"

Вот простой пример:

public enum JiraResource
{
    project
}

protected string RunQuery(
    JiraResource resource, 
    string argument = null, 
    string data = null,
    string method = "GET")
{
    string url = string.Format("{0}{1}/", m_BaseUrl, resource.ToString());

    if (argument != null)
    {
        url = string.Format("{0}{1}/", url, argument);
    }

    HttpWebRequest request = WebRequest.Create(url) as HttpWebRequest;
    request.ContentType = "application/json";
    request.Method = method;

    if (data != null)
    {
        using (StreamWriter writer = new StreamWriter(request.GetRequestStream()))
        {
            writer.Write(data);
        }
    }

    string base64Credentials = GetEncodedCredentials();
    request.Headers.Add("Authorization", "Basic " + base64Credentials);

    HttpWebResponse response = request.GetResponse() as HttpWebResponse;

    string result = string.Empty;
    using (StreamReader reader = new StreamReader(response.GetResponseStream()))
    {
        result = reader.ReadToEnd();
    }

    return result;
}

private string GetEncodedCredentials()
{
    string mergedCredentials = string.Format("{0}:{1}", m_Username, m_Password);
    byte[] byteCredentials = UTF8Encoding.UTF8.GetBytes(mergedCredentials);
    return Convert.ToBase64String(byteCredentials);
}

(JiraResource - это просто перечисление, которое я использую, чтобы решить, какую часть API использовать)

Я надеюсь, это поможет!

Ответ 2

Вот более простое решение, которое работает по мере необходимости:

var mergedCredentials = string.Format("{0}:{1}", username, password);
var byteCredentials = Encoding.UTF8.GetBytes(mergedCredentials);
var encodedCredentials = Convert.ToBase64String(byteCredentials);

using (WebClient webClient = new WebClient())
{
    webClient.Headers.Set("Authorization", "Basic " + encodedCredentials);

    return webClient.DownloadString(url);
}

Ответ 3

Если вы не хотите кодировать свои учетные данные в каждом запросе, вот как это сделать, используя файлы cookie.

При запросе файла cookie вам не нужно добавлять авторизацию в заголовки. Этот метод будет принимать строку JSON с именем пользователя и паролем и URL-адресом. Он вернет значения cookie.

public async Task<JiraCookie> GetCookieAsync(string myJsonUserNamePassword, string JiraCookieEndpointUrl)
{
    using (var client = new HttpClient())
        {
            var response = await client.PostAsync(
                JiraCookieEndpointUrl,
                new StringContent(myJsonUserNamePassword, Encoding.UTF8, "application/json"));
            var json = response.Content.ReadAsStringAsync().Result;
                var jiraCookie= JsonConvert.DeserializeObject<JiraCookie>(json);
                return jArr;
         }
}

public class JiraCookie
{
    public Session session { get; set; }
}

public class Session
{
    public string name { get; set; }
    public string value { get; set; }
}

Когда я вызываю его с помощью url: http://[baseJiraUrl]/rest/auth/1/session, он возвращает следующий ответ JSON:

{
"session" : -{
"name" : JSESSIONID,
"value" : cookieValue
}

Имейте в виду, что указанный выше URL-адрес действителен в версии JIRA, которую я использую, и может отличаться в зависимости от используемой вами версии. Ознакомьтесь с документацией API JIRA для правильного URL-адреса для используемой версии. Я использую следующее: https://docs.atlassian.com/software/jira/docs/api/REST/7.6.1/#auth/1/session

Помните, что вам придется хранить ваш файл cookie и использовать его при каждом последующем запросе. Ознакомьтесь с этим ответом о том, как добавлять файлы cookie в запрос HttpClient: как установить cookie в HttpRequestMessage HttpClient.

Как только вы закончите работу с cookie (выйдите из системы), просто отправьте HTTP-запрос удаления с тем же URL-адресом, что и сообщение.

Ответ 4

Я изменил код RunQuery, чтобы он работал сегодня (апрель 2018 года). Шифрование/дешифрование, приведенное ниже, происходит из следующей ссылки (я преобразовал ее в метод расширения и выбросил значения в среду).

fooobar.com/questions/13770/...

Я успешно выполняю код из LinqPad - таким образом, команда Dump() после RunQuery

private string _baseUrl = "https://xxxxxx.atlassian.net";
private string _username = "YourLogin";

void Main()
{
    RunQuery(JiraResource.project).JsonToXml().Dump();
}

public enum JiraResource { project }

private const string restApiVersion = "/rest/api/2/";

protected string RunQuery(  JiraResource resource,  string argument = null, string data = null, string method = "GET")
{
    string url = $"{_baseUrl}{restApiVersion}{resource}";

    if (argument != null) url = $"{url}{argument}/";

    var request = WebRequest.Create(url) as HttpWebRequest;
    request.ContentType = "application/json";
    request.Method = method;

    if (data != null)
    {
        using (StreamWriter writer = new StreamWriter(request.GetRequestStream()))
        {
            writer.Write(data);
        }
    }
    string base64Credentials = GetEncodedCredentials();
    request.Headers.Add("Authorization", "Basic " + base64Credentials);

    var response = request.GetResponse() as HttpWebResponse;
    string result = string.Empty;
    using (StreamReader reader = new StreamReader(response.GetResponseStream()))
    {
        result = reader.ReadToEnd();
    }
    return result;
}

private string GetEncodedCredentials()
{
    var encryptedPassword = Environment.GetEnvironmentVariable("PassEncrypted");
    var encryptionSalt = Environment.GetEnvironmentVariable("PassSalt");
    var password = encryptedPassword.Decrypt(encryptionSalt);

    var mergedCredentials = $"{_username}:{password}";
    var byteCredentials = UTF8Encoding.UTF8.GetBytes(mergedCredentials);
    return Convert.ToBase64String(byteCredentials);
}

public static class MyExtensions
{
    public static XElement JsonToXml(this string jsonData, bool isAddingHeader = true)
    {
        var data = isAddingHeader
            ? "{\"record\":" + jsonData + "}"
            : jsonData;

        data = data // Complains if xml element name starts numeric
            .Replace("16x16", "n16x16")
            .Replace("24x24", "n24x24")
            .Replace("32x32", "n32x32")
            .Replace("48x48", "n48x48");

        var result = JsonConvert.DeserializeXmlNode(data, "data");
        var xmlResult = XElement.Parse(result.OuterXml);
        return xmlResult;
    }
}

Ответ 5

Для публикации многостраничного содержимого в Rest я использую Tiny.RestClient.

var client = new TinyRestClient(new HttpClient(), "http://localhost:8090");

var strResult = await client.PostRequest("rest/auth/latest/session).
WithBasicAuthentication("username", "password")
ExecuteAsStringAsync();