Postman と REST API を使用して Atlassian Cloud からグループを削除する (Confluence Cloud のみを使用するサイト)
プラットフォームについて: Cloud のみ - この記事は クラウド プラットフォームのアトラシアン製品に適用されます。
この記事を使用すべきタイミング
この記事は、Atlassian Cloud からグループを一括削除する必要があるときはいつでも使用できます。たとえば、Atlassian Cloud へのユーザー移行をテストした後、再テストするために組織から多くのグループを削除する必要がある場合があります。
この記事は「Postman と REST API を使用して Atlassian Cloud からグループを削除する」と似ていますが、本記事は Confluence のみを使用していて Jira を使用していないサイトを対象としています。
この記事を使用すべきでないタイミング
この記事は、アトラシアン ガード SCIM でプロビジョニングされたユーザーとグループを持つ組織には適用されません。これらのグループは次のアップデート/同期後に再作成されるためです。SCIM を通じてプロビジョニングされたグループを変更するには、ID プロバイダー管理者にお問い合わせください。
組織のユーザー管理 UI エクスペリエンスを識別する
admin.atlassian.com にアクセスします。 複数の組織がある場合は、対象の組織を選択します。
オリジナル | 集中型 |
サイト管理者または組織管理者である場合は、[ユーザー] は製品サイトで確認できます。[ユーザー] ページが [ディレクトリ] タブに存在しない場合は、従来のユーザー管理 UI エクスペリエンスを利用していることになります。 | 組織管理者として、[ユーザー] は [ディレクトリ] タブで確認できます。 |
データを準備する
admin.atlassian.com に移動します。複数の組織がある場合は、対象の組織を選択します。
このステップは、ご利用のユーザー管理エクスペリエンスによって異なります。
- オリジナル: サイトの名前と URL を選び、そのサイトの [管理] を開いて [ユーザー] を選択します。
- 一元管理: [ディレクトリ] > [ユーザー] の順に選択します。このステップは、ご利用のユーザー管理エクスペリエンスによって異なります。
- オリジナル: [ユーザーをエクスポート] を選択します。
-一元管理: 画面の上部にある […] > [ユーザーをエクスポート] を選択します。エクスポートしたいユーザーを選択します。
サイト/組織内のすべてのユーザー – サイト/組織内にいるすべてのグループ全体のすべてのユーザーが含まれます。
選択したグループのユーザーのみ – 選択したグループのユーザーのみが含まれます。
[すべてのユーザー] を選択すると、アクティブ、一時停止中、非アクティブのユーザーがすべて含まれます。
さらに以下のオプションを選択します。
[グループ メンバーシップ] – ユーザーが所属しているグループを含みます。初期設定では、複数のグループはコンマ区切りのリストとしてフォーマットされます。
[列にピボット] – グループ データをコンマ区切りリストから [グループ名] という列リストに展開します。[グループ ID] の新しい列も追加されます。
[ユーザーをエクスポート] を選択します。
CSV ファイルをダウンロードする準備が整ったら、メールが届きます。しばらくしてもメールが届かない場合は、迷惑メール フォルダーをご確認ください。
メールを開いて [CSV ファイルをダウンロード] を選択します。ログインしていない場合は、ダウンロードを開始する前にログインする必要が生じる場合があります。
表計算プログラムやテキスト エディターを使用して、列 C 以降を削除します。これで、CSV ファイルには 2 列だけが残ります。
- 重複する行をすべて削除します。そうすることで、データの確認が容易になります。
削除すべきでない行 (グループ) をすべて削除します。
削除するすべてのグループを含むリストになった CSV ファイルを保存します。
これで、CSV は次のようになるはずです。
A | B | |
---|---|---|
1 | グループ ID | Group 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」という名前の環境が設定済みである
REST API 呼び出しを設定する
[New (新規)] をクリックするか、
Ctrl
+N
キー (Windows/Linux) またはCmd
+N
キー (macOS) を押します。[HTTP] を選択します。
リクエスト名を「Remove Group from Atlassian Cloud (Confluence only) (Atlassian Cloud からのグループの削除 (Confluence のみ))」に設定します。
メソッドを
GET
からDELETE
に変更します。URL に以下を貼り付けます。
{{cloudUrl}}/wiki/rest/api/group/by-id?id={{Group id}}
[Authorization (認証)] タブをクリックします。
[Type (タイプ)] が [Inherit auth from parent (親から認証を継承)] であることを確認します。
[Save (保存)] をクリックして、[Atlassian Cloud User Management (Atlassian Cloud ユーザー管理)] コレクションに保存します。
Runner を実行する
Postman の右上にある環境セレクターで [Atlassian Cloud] を選択し、環境を変更します。
サイドバーの [Collections (コレクション)] を選択します。
[Atlassian Cloud User Management (Atlassian Cloud ユーザー管理)] コレクションを選択します。
[Overview (概要)] タブで、右上の実行ボタン ▶️ を選択します。
[実行順序] の下で、REST API 呼び出しが 1 つ (「Remove Group from Atlassian Cloud (Confluence only) (Atlassian Cloud からのグループの削除 (Confluence のみ))」) だけであることを確認します。
[Functional (機能)] タブで、[Run manually (手動で実行)] を選択します。
[Data (データ)] をクリックします。
事前に準備した CSV ファイルの場所に移動して選択します。
[Run configuration (実行設定)] の [Iterations (イテレーション)] の数を 1 に減らします。
グループの削除は破壊的かつ不可逆的なアクションです。すべてのグループを体系的に削除する前に、1 つのグループでテストして結果を確認することを強くお勧めします。
[Advanced settings (詳細設定)] はそのまま残します。
[Run Atlassian Cloud User Management (Atlassian Cloud ユーザー管理の実行)] をクリックします。
Postman をチェックして、ランナー コレクションがすべてのテストに合格していることを確認します。実行結果は次のように表示されるはずです。
[Iterations (イテレーション)] と [All tests (すべてのテスト)] の回数が同じ
Passed (n) (成功) (n は [Iterations (イテレーション)] の数)
Failed (0) (失敗)
Skipped (0) (スキップ)
admin.atlassian.com をチェックして、グループ数が 1 つ減っていることを確認します。
[Iterations (イテレーション)] の数を CSV ファイルの行数に設定し、前の手順に従って Postman Runner を再実行します。すでに削除されたグループを削除することはできないため、エラーが 1 つ発生することが予想されます。
参考
- サイトからユーザーをエクスポートする
- Excel - 重複項目を検索して削除する
- Google スプレッドシート - テキストを分割する、重複項目を削除する、空白を削除する
- Confluence Cloud REST API - ユーザー グループの削除
- Postman - Collection Runner を使用する