Postman と REST API を使用して Atlassian Cloud のグループ メンバーシップを一括削除する

お困りですか?

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

コミュニティに質問


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

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

この記事は、Atlassian Cloud でグループ メンバーシップを一括で更新/追加する必要がある際に役立ちます。この記事ではメンバーシップの更新方法に関する概要をご説明します。なお、Jira プロジェクトのグループの使用状況、Jira 権限スキーム、Confluence スペース権限、または Confluence ページの制限は更新されません。

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

この記事は、アトラシアン ガード SCIM でプロビジョニングされたユーザーとグループを持つ組織には適用されません。SCIM を通じてプロビジョニングされたグループのメンバーシップを変更するには、ID プロバイダー管理者にお問い合わせください。



組織のユーザー管理を確認する

  1. admin.atlassian.com にアクセスします。 複数の組織がある場合は、対象の組織を選択します。

オリジナル

集中型

サイト管理者または組織管理者として、[ユーザー] は [Product site (製品サイト)] の下で確認できます。

組織管理者として、[ユーザー] は [ディレクトリ] タブで確認できます。

データを準備する

この記事では、削除するユーザーとグループの各メンバーシップのリストがすでに用意されているか、あらかじめ決まっていることを前提としています。この記事では、ユーザー ID とグループ ID をマッピングするステップをご説明します。

元のデータ

ファイルの例


AB
​1メールグループ
2vdillow@banc.lyoslo-engineering
3ftoten2@banc.lyhanoi-legal
4amelmeth@banc.lyhouston-sales

ユーザー識別子を取得する

  1. admin.atlassian.com に移動します。複数の組織がある場合は、対象の組織を選択します。
  2. このステップは、ご利用のユーザー管理エクスペリエンスによって異なります。
    - オリジナル: サイトの名前と URL を選び、そのサイトの [管理] を開いて [ユーザー] を選択します。
    - 一元管理: [ディレクトリ] > [ユーザー] の順に選択します。

  3. このステップは、ご利用のユーザー管理エクスペリエンスによって異なります。
    - オリジナル: [ユーザーをエクスポート] を選択します。
    -一元管理: 画面の上部にある […] > [ユーザーをエクスポート] を選択します。

  4. エクスポートしたいユーザーを選択します。

    • サイト/組織内のすべてのユーザー – サイト/組織内にいるすべてのグループ全体のすべてのユーザーが含まれます。

    • 選択したグループのユーザーのみ – 選択したグループのユーザーのみが含まれます。

  5. [すべてのユーザー] を選択すると、アクティブ、一時停止中、非アクティブのユーザーがすべて含まれます。

  6. [ユーザーをエクスポート] を選択します。
  7. CSV ファイルをダウンロードする準備が整ったら、メールが届きます。しばらくしてもメールが届かない場合は、迷惑メール フォルダーをご確認ください。
  8. メールを開いて [CSV ファイルをダウンロード] を選択します。
  9. ファイルの名前を users.csv に変更します。
  10. 表計算プログラムを使用して、列 D 以降を削除します。これで、CSV ファイルには 3 列だけが残ります。
  11. CSV ファイルを保存します。

サンプル ファイル - users.csv


ABc
​1​ユーザー IDユーザー名​メール​
26155833c071axxx071ff5b24Janaye Floatjfloat@banc.ly
37a4b625f3fd5xxx24d741ac7Anissa Melmethamelmeth@banc.ly
4e2345d51eaa4xxx984e377ceVerna Dillowvdillow@banc.ly
53c5e0172a629xxx061259ed9Dorice Snapperdsnapper@banc.ly
6982bfd68520fxxx71daccb32Florian Totenftoten2@banc.ly

グループ識別子を取得する

  1. このステップは、ご利用のユーザー管理エクスペリエンスによって異なります。
    - オリジナル: [ユーザーをエクスポート] を選択します。
    -一元管理: 画面の上部にある […] > [ユーザーをエクスポート] を選択します。
  2. さらに以下のオプションを選択して、ダウンロードに含めるデータを追加します。これらのオプションはデータのフィルタリングに役立つ場合があります。

    • [グループ メンバーシップ] – ユーザーが所属しているグループを含みます。初期設定では、複数のグループはコンマ区切りのリストとしてフォーマットされます。

      • [列にピボット] – グループ データをコンマ区切りリストから [グループ名] という列リストに展開します。[グループ ID] の新しい列も追加されます。

  3. [ユーザーをエクスポート] を選択します。

  4. CSV ファイルをダウンロードする準備が整ったら、メールが届きます。しばらくしてもメールが届かない場合は、迷惑メール フォルダーをご確認ください。

  5. メールを開いて [CSV ファイルをダウンロード] を選択します。

  6. ファイルの名前を groups.csv に変更します。
  7. 表計算プログラムを使用して、列 C 以降を削除します。これで、CSV ファイルには 2 列だけが残ります。

  8. 重複する行をすべて削除します。
    1. Excel - すべての値を強調表示して、[データ] > [データ ツール] > [重複の削除] をクリックします。
    2. Google スプレッドシート - すべての値を強調表示して、[データ] > [データ クリーンアップ] > [重複を削除] をクリックします。
  9. CSV ファイルを保存します。

サンプル ファイル - groups.csv


AB
​1グループ ID​グループ名​
2d6750b14-1aa8-4ab2-xxxx-a6d44016da32oslo-engineering
3396fae73-650c-4265-xxxx-9c840897fc68houston-sales
40b200647-b447-4eaf-xxxx-55ec31a7d4c9hanoi-legal
52e6317f2-8c9f-4abb-xxxx-afd8fb7c3ebelille-product-management
6705e51a5-b12b-4587-xxxx-f42bc099b777porto-alegre-support

データをマッピングする

  1. 表計算プログラムで、グループとユーザーの元のリストを開きます。
  2. 新しいタブに、先ほど作成した users.csv をインポートします。これにより、タブが「users」という名前になります。
  3. 新しいタブに、先ほど作成した groups.csv をインポートします。これにより、タブが「groups」という名前になります。
  4. 元のリストを含むスプレッドシート タブを開きます。
  5. 列 A と B にそれぞれ対象のユーザーのメール アドレスとグループ名が含まれていることを確認します。

  6. セル C1 に、列ヘッダーとして accountId というラベルを付けます。大文字と小文字を区別してください。
  7. セル C2 に、次のように入力します。

    =XLOOKUP($A2,users!$C$2:$C$1000,users!$A$2:$A$1000,"")

    (warning) Ensure that A2:C1000 in the sheet users covers all users. This assumes column A contains the "Account id" and column C contains "email address" in users . The value of "1000" may need to be increased.

  8. 残りのセルに同等の数式を入力し、$A2 が同じ行の対応するセルに更新され、残りの引数は同じであることを確認します。
  9. ランダム チェックを実行して、ルックアップが想定どおりに動作していることを確認します。
  10. セル D1 に、列ヘッダーとして groupId というラベルを付けます。大文字と小文字を区別してください。
  11. セル D2 に、次のように入力します。

    =XLOOKUP($B2,groups!$B$2:$B$1000,groups!$A$2:$A$1000,"")

    (warning) Ensure that A2:C1000 in the sheet groups covers all groups. This assumes column A contains the "Group id" and column B contains "Group name" in groups . The value of "1000" may need to be increased.

  12. 残りのセルに同等の数式を入力し、$A2 が同じ行の対応するセルに更新され、残りの引数は同じであることを確認します。
  13. ランダム チェックを実行して、ルックアップが想定どおりに動作していることを確認します。
  14. 結果のリストには、アカウント ID とグループ ID が追加され、4 つの列が含まれているはずです。
  15. 結果のリストを csv 形式で保存します。

ファイルの例


ABcd
​1メールグループアカウント IDgroupid
2vdillow@banc.lyoslo-engineeringe2345d51eaa4xxx984e377ced6750b14-1aa8-4ab2-xxxx-a6d44016da32
3ftoten2@banc.lyhanoi-legal982bfd68520fxxx71daccb320b200647-b447-4eaf-xxxx-55ec31a7d4c9
4amelmeth@banc.lyhouston-sales7a4b625f3fd5xxx24d741ac7396fae73-650c-4265-xxxx-9c840897fc68

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 (保存)] をクリックします。

REST API 呼び出しを設定する

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

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

  3. リクエストに「Atlassian Cloud のグループからユーザーを削除」という名前をつけます。

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

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

    {{cloudUrl}}/rest/api/2/group/user?groupId={{groupId}}&accountId={{accountId}}

    (warning) Postman の変数は大文字と小文字が区別され、指定の環境とスプレッドシートで提供されているものと一致している必要があることに注意してください。

  6. [Authorization (認証)] タブをクリックします。

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

  8. [Save (保存)] をクリックして、[Atlassian Cloud User Management (Atlassian Cloud ユーザー管理)] コレクションに保存します。

Postman Runner を実行する 

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

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

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

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

  5. [実行順序] で、REST API 呼び出しが 1 つ(「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. admin.atlassian.com をチェックして、エクスポートしたリストの行 2 のユーザーが想定したグループのメンバーになっていることを確認します。

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

参考


最終更新日 2024 年 5 月 21 日

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

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