[PYTHON] Verwenden Sie die REST-API mit JIRA (Benutzerregistrierung als Beispiel).

Beschrieben, weil es im Zusammenhang mit dem Geschäft untersucht wurde.

Zweck

Als Beispiel für die Verwendung der REST-API in JIRA In diesem Abschnitt wird das Verfahren zur Benutzerregistrierung beschrieben.

Annahme

--jira Version ist 7.1.8 --jira wird auf https veröffentlicht

Es funktioniert möglicherweise nicht, wenn es auf HTTP veröffentlicht wird. (unbestätigt)

Da ich Python verwende, sind auch die folgenden Bedingungen erforderlich.

• Python 3.5.2 --Verwendungsmodul verwenden

Überblick

Registrieren Sie einen bestimmten Benutzer, indem Sie die REST-API von JIRA aus Python-Code aufrufen.

einfache Erklärung

Grundsätzlich ist es möglich, die angegebene HTTP-Methode und Authentifizierungsinformationen an den Pfad von Dokumentbeschreibung zu übergeben. .. Dieses Mal treffe ich die Benutzerregistrierungs-API als Beispiel.

Darüber hinaus müssen die folgenden Bedingungen erfüllt sein, um die folgende REST-API zu erreichen.

• Der Benutzer authentifiziert sich mit der Standardauthentifizierung
• Die REST-API kann nur für die Vorgänge ausgeführt werden, die von den oben genannten Benutzern ausgeführt werden können.
• Mit anderen Worten, Sie müssen zur Gruppe der Jira-Administratoren gehören, um die Benutzerregistrierung mit der REST-API von JIRA durchführen zu können.

Verwendung der Benutzerregistrierungs-API

Zielpfad anfordern

/rest/api/2/user

Verwenden Sie POST für die Methode.

Text anfordern

Körperprobe anfordern

{
    "name": "test_taro",
    "emailAddress": "[email protected]",
    "displayName": "Testen Sie Taro",
    "applicationKeys": 
            "jira-software",
    ],
}

Beispielcode

Beispielcode

import requests
from requests import RequestException

#Zielhost anfordern
TARGET_HOST = "atlassian.example.com"
CONTEXT = "/jira"
USER_CREATE_PATH="/rest/api/2/user"

request_body = {
    "name": "test_taro",
    "emailAddress": "[email protected]",
    "displayName": "Testen Sie Taro",
    "applicationKeys": 
            "jira-software",
    ],
}

request_path = "https://"+TARGET_HOST+CONTEXT+USER_CREATE_PATH
try:
    response = requests.post(request_path, auth=('jira_admin_user','hogehoge'),json=request_body)
except RequestException as err:
    print(str(err))
print(str(response))

Referenzmaterial

• Moduldokumentation anfordern
  • http://docs.python-requests.org/en/master/ --Offizielles Dokument
  • https://docs.atlassian.com/jira/REST/7.1.8/