Netskope SCIM APIを使用してNetskopeアカウントを削除する – ペンティオヘルプセンター

本記事では、Netskope API リクエストによるNetskopeアカウントの削除方法をPostmanを使用して解説します。

実行のステップ

NetskopeのAPIを使用してNetskopeアカウントを削除するために、まずはNetskopeアカウントのユーザーIDを取得する必要があります。そのため、本記事ではまずユーザー情報を取得したのち、削除のAPIを実行しております。

Get Users を実行し、アカウントの削除に必要なNetskopeのユーザーIDを取得
取得したユーザーIDを用いて、Delete User を実行

1. Postmanの設定

Netskope API v2 のトークンを取得します。トークンの取得方法については、下記ドキュメントを参考に操作をお願いいたします
REST API v2 トークンを生成・取得する手順
Netskope SCIM APIのPostmanコレクションを取得するため、下記リンクにアクセスします
Netskope Rest APIv2(OAS 3.1)
Netskope Rest APIv2(OAS 3.1) コレクションの［View more actions］> ［Export］をクリックします
Collection v2.1 が選択されていることを確認し、［Export］をクリックします
左側のメニューから、［Environment］を選択します
environment_template の［View more actions］> ［Export］をクリックします
お使いのPostmanにて［Import］をクリックします
手順4および手順6にてダウンロードしたコレクションと環境変数を選択し、［Import］をクリックします
左側のメニューから、［Environments］を選択し、インポートした環境変数の［Set active］をクリックし有効化します
手順8にてインポートした環境変数を選択し、rest_api_2_keyの Current value に手順1で取得した Netskope API v2 のトークン を入力します
右上の［Save］をクリックします
左側のメニューから［Collections］を選択します
［Netskope Rest APIv2(OAS 3.1)］を選択し、［Variables］を選択します
お使いのNetskopeのテナント名を入力します
Netskopeのドメインがpentio.goskope.comの場合、https://pentio.goskope.com を入力します
右上の［Save］をクリックします
Netskope Rest APIv2(OAS 3.1) > api/v2 > scim > Users >［Get Scim Users］を選択します
実行するAPIを、以下のように設定します
GET : {{baseUrl}}/api/v2/scim/Users?filter=userName eq "{{user_account}}"

以降の手順は、削除するアカウントが複数かどうかによって手順が異なるため、セクションを分けてご紹介します。1アカウントのみもしくは 1アカウントずつ削除を行う場合は、1アカウントごとに削除する場合にお進みください。

2. 削除操作の実行

1. CSVを使用して複数アカウントを一括で削除する場合

下記画像のように、削除したいNetskopeアカウントのメールアドレスがリストとなっているCSVファイル* を作成します
* 下記の例では、CSVファイルの閲覧・作成にNumbersを使用しております
［Scripts］タブ > Pre-request を選択します

Pre-request内に、下記のスクリプトを入力します

//csvのキー指定データ読み取り
const users= data["userName"];

//bodyに指定した変数をセット
pm.environment.set("user_account", users);

右上の［Save］をクリックします
Postmanにて、Usersフォルダの View more actions から、［Run folder］を選択します
Get Scim Users のみにチェックを入れます
右側のメニューから［Select File］を選択し、手順2.1.1 にて作成したCSVファイルを選択します
*Run configuration > Iterations から、CSV上のデータ数が正しいことを確認することを推奨いたします。
Persist responses for a session にチェックをいれ、［Run Netskope Rest API 2(OAS 3...］をクリックします
各ユーザーの実行結果が確認できます。各ユーザーのレスポンス内のIDをコピーします
手順2.1.1 にて作成したCSVファイルに「userId」の列を追加し、各ユーザーのIDを入力します
右側のメニューから、Delete SCIM User record by {ID} を選択します
実行するAPIを、以下のように設定します
DELETE : {{baseUrl}}/api/v2/scim/Users/{{scim_user_id}}
［Scripts］タブ > Pre-request を選択します

Pre-request内に、下記のスクリプトを入力します

//csvのキー指定データ読み取り
const users= data["userId"];

//bodyに指定した変数をセット
pm.environment.set("scim_user_id", users);

右上の［Save］をクリックします
{id}フォルダの View more actions から、［Run folder］を選択します
Delete SCIM User record by {ID} のみにチェックを入れます
［Select File］から手順2.1.7にて追記したCSVファイルを選択したのち、［Run Netskope Rest API 2(OAS 3...］をクリックします
204 NO CONTENT というレスポンスが返ってきましたら、正常にアカウント削除ができております