[PYTHON] Utiliser l'API REST avec JIRA (enregistrement de l'utilisateur comme exemple)

Décrit parce qu'il a fait l'objet d'une enquête en rapport avec les affaires.

Objectif

Comme exemple d'utilisation de l'API REST dans JIRA Cette section décrit la procédure d'enregistrement des utilisateurs.

supposition

La version --jira est 7.1.8 --jira est publié sur https

Cela peut ne pas fonctionner s'il est publié sur HTTP. (non confirmé)

De plus, puisque j'utilise Python, les conditions suivantes sont également requises.

• Python 3.5.2 --Utiliser le module Demandes

Aperçu

Enregistrez un utilisateur spécifique en appuyant sur l'API REST de JIRA à partir du code Python.

explication facile

Fondamentalement, il est possible d'opérer en passant la méthode HTTP spécifiée et les informations d'authentification au chemin de Description du document. .. Cette fois, j'utilise l'API d'enregistrement des utilisateurs comme exemple.

De plus, les conditions suivantes doivent être remplies pour accéder à l'API REST suivante.

• L'utilisateur s'authentifie avec l'authentification de base
• L'API REST ne peut être exécutée que pour les opérations pouvant être effectuées par les utilisateurs ci-dessus.
• En d'autres termes, vous devez appartenir au groupe jira-administrator pour effectuer l'enregistrement des utilisateurs avec l'API REST de JIRA.

Utilisation de l'API d'enregistrement des utilisateurs

Demander le chemin de destination

/rest/api/2/user

Utilisez POST pour la méthode.

Demander un corps

Demander un échantillon corporel

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

Exemple de code

Exemple de code

import requests
from requests import RequestException

#Demander l'hôte de destination
TARGET_HOST = "atlassian.example.com"
CONTEXT = "/jira"
USER_CREATE_PATH="/rest/api/2/user"

request_body = {
    "name": "test_taro",
    "emailAddress": "[email protected]",
    "displayName": "Tester 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))

Matériel de référence

--Demander la documentation du module - http://docs.python-requests.org/en/master/ --Document officiel - https://docs.atlassian.com/jira/REST/7.1.8/