web-dev-qa-db-ja.com

C＃を使用したJIRA RestAPIログイン

JIRA Rest APIにログインするためのC＃コードを以下に記述しました。

var url = new Uri("http://localhost:8090/rest/auth/latest/session?os_username=tempusername&os_password=temppwd");
var request = WebRequest.Create(url) as HttpWebRequest;
if (null == request)
{
 return "";
}
request.Method = "POST";
request.ContentType = "application/json";
request.ContentLength = 200;
request.KeepAlive = false;
using (var response = request.GetResponse() as HttpWebResponse)
{
}

これを実行すると、アプリケーションは応答を返さずに実行を続けます。これがREST APIを使用してJIRAログインを呼び出す正しい方法であるかどうかを提案してください

c#restjira
15
user1585432

基本認証の場合、base64エンコーディングでユーザー名とパスワードを送信する必要があります。ガイドラインは、アトラシアン開発者ページのAPI例にあります： https://developer.atlassian.com/display/JIRADEV/JIRA+REST+API+Example+-+Basic+Authentication 、 C＃でそれを行うには、エンコードされたデータを次の形式でヘッダーに送信する必要があります。

"認証：基本[エンコードされた資格情報]"

簡単な例を次に示します。

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のどの部分を使用するかを決定するために使用する列挙型です）

これがお役に立てば幸いです。

35
Maffelu

必要に応じて機能する、より簡単なソリューションを次に示します。

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);
}
4
Rob King

すべてのリクエストで認証情報をエンコードしたくない場合は、Cookieを使用してエンコードする方法を説明します。

Cookieを要求する場合、ヘッダーに認証を追加する必要はありません。このメソッドは、ユーザー名とパスワード、およびURLを含むJSON文字列を受け入れます。 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のバージョンで有効であり、使用しているバージョンによって異なる場合があることに注意してください。使用しているバージョンの正しいURLについては、JIRAAPIドキュメントをお読みください。私は以下を使用しています： https://docs.atlassian.com/software/jira/docs/api/REST/7.6.1/#auth/1/session

Cookieを保存し、その後のすべてのリクエストで使用する必要があることを忘れないでください。 HttpClientリクエストにCookieを追加する方法については、次の回答を確認してください。 HttpClientのHttpRequestMessageにCookieを設定するにはどうすればよいですか 。

Cookieの処理（ログアウト）が完了したら、投稿と同じURLを使用してhttpの削除リクエストを送信するだけです。

2
ismael.

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();
0
user8803505

今日（2018年4月）に実行されるようにRunQueryコードを微調整しました。以下で参照されている暗号化/復号化は、次のリンクからのものです（拡張メソッドに変換し、値を環境にスローしました）。

https://stackoverflow.com/questions/10168240/encrypting-decrypting-a-string-in-c-sharp

LinqPad -からコードを正常に実行しました。したがって、RunQueryの後にDump（）コマンドを実行します。

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;
    }
}
0
BillKrat
static void Main(string[] args)
{
    using (WebClient wc = new WebClient())
    {
        wc.Headers.Add("Authorization", "Basic " + GetEncodedCredentials());

        string tasks = wc.DownloadString("yourjiraurl/search?jql=task=bug");
        var taskdetails = JsonConvert.DeserializeObject<TaskDetails>(tasks);
    }
}

static string GetEncodedCredentials()
{
    string mergedCredentials = string.Format("{0}:{1}", "UserName", "Password");
    byte[] byteCredentials = UTF8Encoding.UTF8.GetBytes(mergedCredentials);
    return Convert.ToBase64String(byteCredentials);
}
0
Anup