Postman と REST API を使用して Atlassian Cloud にチームを作成する
プラットフォームについて: Cloud のみ - この記事は クラウド プラットフォームのアトラシアン製品に適用されます。
この記事を使用すべきタイミング
この記事は、Atlassian Cloud でチームを一括作成する必要があるときに参照いただくものです。
データを準備する
- テキスト エディターを使用して、作成するすべてのチームの名前を記載したテキスト文書と、必要であれば説明を記載した 2 列目の文書を作成します。
- 最初の行に「
teamName,teamDescription
」というラベルの付いたヘッダー行があることを確認します。チームの説明は必須ではありませんが、REST API の呼び出しには必須です。
- 作成するチームのリストを記述した CSV としてファイルを保存します。
ファイルの例
teamName,teamDescription
Transformers,Business transformation team
Project Matrix,
Platform CORE,
Team Cardguard,InfoSec
Pipedream,API team
Postman を設定する
以下の場合は、このセクションを省略できます。
「Atlassian Cloud User Management (Atlassian Cloud ユーザー管理)」という名前のコレクションが設定済みである
「Atlassian Cloud」という名前の環境が設定済みである
組織 ID を検索
- [admin.atlassian.com] に移動します。
- 複数の組織がある場合は、対象の組織を選択します。
- 次の URL から組織 ID を確認します。
https://admin.atlassian.com/o/<orgId>/overview
ここでの組織 ID (orgId) は GUID です。次に例を示します。
7d737580-498a-1b1c-kcd1-kdjj1d0bada9
サイト ID を検索
- [admin.atlassian.com ] に移動します 。
- 複数の組織がある場合は、対象の組織を選択します。
- 上部のナビゲーション バーから [ 製品 ] を選択します 。
- 左側のナビゲーション ウィンドウで、サイトを選択します。
- 次の URL からサイト ID を確認します。
https://admin.atlassian.com/s//access-requests
ここでのサイト ID (site id) は GUID です。例:
6dbf9191-c42b-4988-97d7-45cb4f1112f7
REST API 呼び出しを設定する
[New (新規)] をクリックするか、
Ctrl
+N
キー (Windows/Linux) またはCmd
+N
キー (macOS) を押します。[HTTP] を選択します。
リクエストに「Create Team in Atlassian Cloud (Atlassian Cloud にチームを作成)」という名前をつけます。
メソッドを
GET
からPOST
に変更します。URL に以下を貼り付けます。
{{cloudUrl}}/gateway/api/public/teams/v1/org/<orgId>/teams/
- URL 内の
<orgId>
を、以前に取得した組織 ID に置き換えます。 [Authorization (認証)] タブをクリックします。
[Type (タイプ)] が [Inherit auth from parent (親から認証を継承)] であることを確認します。
- [Body (本文)] タブをクリックします。
[raw (行)] をクリックします。
コンテンツ タイプを [JSON] に変更します。
次のブロックをペイロード領域に貼り付けます。
{ "displayName": "{{teamName}}", "description": "{{teamDescription}}", "siteId": "<siteId>", "teamType": "OPEN" }
{{teamName}} と {{teamDescription}} が csv ヘッダーと一致することを確認してください (大文字と小文字は区別されます)。
teamType に使用できる値は次のとおりです。teamType 定義 オープン 組織のメンバーは誰でも承認なしでチームに参加できます。 MEMBER_INVITE チーム メンバーはチーム管理者が招待する必要があります。 - URL 内の
<siteId>
を、以前に取得したサイト ID に置き換えます。 - [Save (保存)] をクリックして、[Atlassian Cloud User Management (Atlassian Cloud ユーザー管理)] コレクションに保存します。
Runner を実行する
Postman の右上にある環境セレクターで [Atlassian Cloud] を選択し、環境を変更します。
サイドバーの [Collections (コレクション)] を選択します。
[Atlassian Cloud User Management (Atlassian Cloud ユーザー管理)] コレクションを選択します。
[Overview (概要)] タブで、右上の実行ボタン ▶️ を選択します。
[実行順序] の下で、REST API 呼び出しが 1 つ (「Create Team in Atlassian Cloud」(Atlassian Cloud にチームを作成)) だけであることを確認します。
[Functional (機能)] タブで、[Run manually (手動で実行)] を選択します。
[Data (データ)] をクリックします。
事前に準備した CSV ファイルの場所に移動して選択します。
[Run configuration (実行設定)] の [Iterations (イテレーション)] の数を 1 に減らします。
[Advanced settings (詳細設定)] はそのまま残します。
[Run Atlassian Cloud User Management (Atlassian Cloud ユーザー管理の実行)] をクリックします。
Postman をチェックして、ランナー コレクションがすべてのテストに合格していることを確認します。実行結果は次のように表示されるはずです。
[Iterations (イテレーション)] と [All tests (すべてのテスト)] の回数が同じ
Passed (n) (成功) (n は [Iterations (イテレーション)] の数)
Failed (0) (失敗)
Skipped (0) (スキップ)
自分のサイト (例: https://bancly.atlassian.net/jira/people/search) でチームをチェックして、チームが追加されていることを確認します。
または、Jira サイトを開いて、上部のナビゲーション バーの [チーム] をクリックします。[Iterations (イテレーション)] の数を CSV ファイルの行数に設定し、前の手順に従って Postman Runner を再実行します。
参考
- developer.atlassian.com - チーム パブリック REST API
- developer.atlassian.com - チーム パブリック API
- Postman - Collection Runner を使用する