Postman と REST API を使用して Atlassian Cloud からグループを削除する (Confluence Cloud のみを使用するサイト)

お困りですか?

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

コミュニティに質問


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

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

この記事は、Atlassian Cloud からグループを一括削除する必要があるときはいつでも使用できます。たとえば、Atlassian Cloud へのユーザー移行をテストした後、再テストするために組織から多くのグループを削除する必要がある場合があります。

この記事は「Postman と REST API を使用して Atlassian Cloud からグループを削除する」と似ていますが、本記事は Confluence のみを使用していて Jira を使用していないサイトを対象としています。

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

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



組織のユーザー管理 UI エクスペリエンスを識別する

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

オリジナル

集中型

サイト管理者または組織管理者である場合は、[ユーザー] は製品サイトで確認できます。[ユーザー]

ページが [ディレクトリ] タブに存在しない場合は、従来のユーザー管理 UI

エクスペリエンスを利用していることになります。

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

データを準備する

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

  2. このステップは、ご利用のユーザー管理エクスペリエンスによって異なります。
    - オリジナル: サイトの名前と URL を選び、そのサイトの [管理] を開いて [ユーザー] を選択します。
    - 一元管理: [ディレクトリ] > [ユーザー] の順に選択します。

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

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

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

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

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

  6. さらに以下のオプションを選択します。

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

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

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

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

  9. メールを開いて [CSV ファイルをダウンロード] を選択します。ログインしていない場合は、ダウンロードを開始する前にログインする必要が生じる場合があります。

  10. 表計算プログラムやテキスト エディターを使用して、列 C 以降を削除します。これで、CSV ファイルには 2 列だけが残ります。

  11. 重複する行をすべて削除します。そうすることで、データの確認が容易になります。
  12. 削除すべきでない行 (グループ) をすべて削除します。

  13. 削除するすべてのグループを含むリストになった CSV ファイルを保存します。

これで、CSV は次のようになるはずです。


AB
​1​グループ IDGroup name
2

4fac65bb-00b7-448c-xxxx-6ef06ca98352

osaka-marketing

3

be81dfc7-2527-4a79-xxxx-42b4f123bc12

freetown-support

4

150d846f-8a0d-44ac-xxxx-f8b35506d16b

sales-app-users

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. リクエスト名を「Remove Group from Atlassian Cloud (Confluence only) (Atlassian Cloud からのグループの削除 (Confluence のみ))」に設定します。

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

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

    {{cloudUrl}}/wiki/rest/api/group/by-id?id={{Group id}}
  6. [Authorization (認証)] タブをクリックします。

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

  8. [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 つ (「Remove Group from Atlassian Cloud (Confluence only) (Atlassian Cloud からのグループの削除 (Confluence のみ))」) だけであることを確認します。

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

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

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

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

    グループの削除は破壊的かつ不可逆的なアクションです。すべてのグループを体系的に削除する前に、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 をチェックして、グループ数が 1 つ減っていることを確認します。

  14. [Iterations (イテレーション)] の数を CSV ファイルの行数に設定し、前の手順に従って Postman Runner を再実行します。すでに削除されたグループを削除することはできないため、エラーが 1 つ発生することが予想されます。

参考


最終更新日 2024 年 5 月 21 日

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

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