Postman と REST API を使用して Atlassian Cloud にチームを作成する

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

プラットフォームについて: Cloud のみ - この記事は クラウド プラットフォームのアトラシアン製品に適用されます。

この記事を使用すべきタイミング

この記事は、Atlassian Cloud でチームを一括作成する必要があるときに参照いただくものです。



データを準備する

  1. テキスト エディターを使用して、作成するすべてのチームの名前を記載したテキスト文書と、必要であれば説明を記載した 2 列目の文書を作成します。
  2. 最初の行に「teamName,teamDescription」というラベルの付いたヘッダー行があることを確認します。
    (warning)チームの説明は必須ではありませんが、REST API の呼び出しには必須です。
  3. 作成するチームのリストを記述した 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」という名前の環境が設定済みである

Postman の設定手順を確認するには、ここをクリックしてください。

Postman をダウンロードする

  1. https://www.postman.com/downloads/ から Postman をダウンロードします。

  2. Postman を実行します。

新しい環境を作成する

  1. [New (新規)] をクリックするか、Ctrl + N キー (Windows/Linux) または Cmd + N キー (macOS) を押します。

  2. [Environment (環境)] を選択します。

  3. 環境名を「Atlassian Cloud」に設定します。

  4. 以下の変数を設定します。

    変数タイプ初期値および現在値コメント

    cloudUrl

    default

    https://<yoursite>.atlassian.net

    yoursite をご利用のサブドメインに置き換えてください。例: acmecorp

    apiTokenEmailAddress

    default

    <youruser@yourdomain.com>

    アトラシアン管理者アカウントのメール

    apiToken

    シークレット

    https://id.atlassian.com/manage-profile/security/api-tokens から取得

    Atlassian アカウントの API トークンを管理する

    Postman の変数では大文字と小文字が区別されます。

  5. 右上の [Save (保存)] をクリックします。

新しいコレクションを作成する

  1. [New (新規)] をクリックするか、Ctrl + N キー (Windows/Linux) または Cmd + N キー (macOS) を押します。

  2. [Collection (コレクション)] を選択します。

  3. コレクション名を「Atlassian Cloud User Management (Atlassian Cloud ユーザー管理)」に設定します。

  4. [Authorization (認証)] タブをクリックします。
  5. [Type (タイプ)] を [Basic Auth (ベーシック認証)] に変更します。

  6. ユーザー名 として {{apiTokenEmailAddress}} を指定します 。Postman が変数の指定を認識したことを示すように、テキストがオレンジ色になります。 これは、変数名にカーソルを合わせることで確認できます。

  7. パスワードとして {{apiToken}} を指定します 。Postman が変数の指定を認識したことを示すように、テキストがオレンジ色になります。 これは、変数名にカーソルを合わせることで確認できます。

  8. [Tests (テスト)] タブをクリックします。

  9. 次の情報を入力します。

    pm.test("Request successful", function () {
        pm.expect(pm.response.code).to.be.oneOf([200,201,202,204]);
    });


    これにより、すべての REST API が正常に作成されていることを確認できます。

  10. 右上の [Save (保存)] をクリックします。

組織 ID を検索

  1. [admin.atlassian.com] に移動します。
  2. 複数の組織がある場合は、対象の組織を選択します。
  3. 次の URL から組織 ID を確認します。
    https://admin.atlassian.com/o/<orgId>/overview
    ここでの組織 ID (orgId) は GUID です。次に例を示します。
    7d737580-498a-1b1c-kcd1-kdjj1d0bada9

サイト ID を検索

  1. [admin.atlassian.com ] に移動します 。
  2. 複数の組織がある場合は、対象の組織を選択します。
  3. 上部のナビゲーション バーから [ 製品 ] を選択します
  4. 左側のナビゲーション ウィンドウで、サイトを選択します。
  5. 次の URL からサイト ID を確認します。
    https://admin.atlassian.com/s//access-requests
    ここでのサイト ID (site id) は GUID です。例:
    6dbf9191-c42b-4988-97d7-45cb4f1112f7

REST API 呼び出しを設定する

  1. [New (新規)] をクリックするか、Ctrl + N キー (Windows/Linux) または Cmd + N キー (macOS) を押します。

  2. [HTTP] を選択します。

  3. リクエストに「Create Team in Atlassian Cloud (Atlassian Cloud にチームを作成)」という名前をつけます。

  4. メソッドを GET から POST に変更します。

  5. URL に以下を貼り付けます。

    {{cloudUrl}}/gateway/api/public/teams/v1/org/<orgId>/teams/
  6. URL 内の <orgId> を、以前に取得した組織 ID に置き換えます。
  7. [Authorization (認証)] タブをクリックします。

  8. [Type (タイプ)] が [Inherit auth from parent (親から認証を継承)] であることを確認します。

  9. [Body (本文)] タブをクリックします。
  10. [raw (行)] をクリックします。

  11. コンテンツ タイプを [JSON] に変更します。

  12. 次のブロックをペイロード領域に貼り付けます。

    {
      "displayName": "{{teamName}}",
      "description": "{{teamDescription}}",
      "siteId": "<siteId>",
      "teamType": "OPEN"
    }

    {{teamName}} と {{teamDescription}} が csv ヘッダーと一致することを確認してください (大文字と小文字は区別されます)。
    teamType に使用できる値は次のとおりです。

    teamType定義
    オープン組織のメンバーは誰でも承認なしでチームに参加できます。
    MEMBER_INVITEチーム メンバーはチーム管理者が招待する必要があります。
  13. URL 内の <siteId> を、以前に取得したサイト ID に置き換えます。
  14. [Save (保存)] をクリックして、[Atlassian Cloud User Management (Atlassian Cloud ユーザー管理)] コレクションに保存します。

Runner を実行する 

  1. Postman の右上にある環境セレクターで [Atlassian Cloud] を選択し、環境を変更します。

  2. サイドバーの [Collections (コレクション)] を選択します。

  3. [Atlassian Cloud User Management (Atlassian Cloud ユーザー管理)] コレクションを選択します。

  4. [Overview (概要)] タブで、右上の実行ボタン ▶️ を選択します。

  5. [実行順序] の下で、REST API 呼び出しが 1 つ (「Create Team in Atlassian Cloud」(Atlassian Cloud にチームを作成)) だけであることを確認します。

  6. [Functional (機能)] タブで、[Run manually (手動で実行)] を選択します。

  7. [Data (データ)] をクリックします。

  8. 事前に準備した CSV ファイルの場所に移動して選択します。

  9. [Run configuration (実行設定)] の [Iterations (イテレーション)] の数を 1 に減らします。

  10. [Advanced settings (詳細設定)] はそのまま残します。

  11. [Run Atlassian Cloud User Management (Atlassian Cloud ユーザー管理の実行)] をクリックします。

  12. Postman をチェックして、ランナー コレクションがすべてのテストに合格していることを確認します。実行結果は次のように表示されるはずです。

    1. [Iterations (イテレーション)] と [All tests (すべてのテスト)] の回数が同じ

    2. Passed (n) (成功) (n は [Iterations (イテレーション)] の数)

    3. Failed (0) (失敗)

    4. Skipped (0) (スキップ)

  13. 自分のサイト (例: https://bancly.atlassian.net/jira/people/search) でチームをチェックして、チームが追加されていることを確認します。
    または、Jira サイトを開いて、上部のナビゲーション バーの [チーム] をクリックします。

  14. [Iterations (イテレーション)] の数を CSV ファイルの行数に設定し、前の手順に従って Postman Runner を再実行します。

参考


最終更新日 2024 年 4 月 24 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.