SCIM APIプロビジョニングの使用
本ページでは、Keeperテナントにユーザーをプロビジョニングするための一般的なAPIプラットフォームであるPostmanの使用方法を記載しました。
環境の設定
Postmanを開きます。
新しいリクエストを作成します。
メソッド: GET、POST、DELETE、PATCH 、PUT
URL: https://keepersecurity.com/api/rest/scim/v2/<node_id>
Keeperテナントのデータセンターに応じて、ドメインが変わります。
米国: keepersecurity.com 欧州: keepersecurity.eu 豪州: keepersecurity.com.au 日本: keepersecurity.jp カナダ: keepersecurity.ca 米国公的機関: govcloud.keepersecurity.us
ヘッダを設定します。
Authorization
Bearer YOUR_AUTH_TOKEN
Content-Type
application/scim+json
ボディを設定します。
rawを選択し、JSON形式を選択します。
ユーザーの追加 - Users/POST
HTTPメソッドとURLを設定します。
ドロップダウンメニューを使用してPOST にHTTPメソッドを設定します。
ユーザーを追加するためのURLを入力します。
ボディを設定します。
URLフィールドの下の「Body」タブをクリックします。
rawを選択し、JSON形式を選択します。
以下のように追加するユーザーの詳細を記載したJSONボディを追加します。
グループ オブジェクトの値に <group_id> を含めることで、作成時にユーザーをチームに追加することもできます。ユーザーをグループに追加する際に必要な情報は<group_id>のみで、「$ref」と「display」はオプションです。
リクエストを送信します。
レスポンスHTTPコード
201
Created
成功
409
Conflict
メールアドレスが既に使用されている
428
Precondition Required
ライセンス数が超過
ユーザーのロック/ロック解除 - Users/PATCH
メソッドをPATCHに設定し、URLを以下のように設定します。
JSONリクエストの本文を設定します。
rawを選択し、JSON形式を選択します。
以下のように追加するユーザーの詳細を記載したJSONボディを追加します。
「value」を必ず「true」 (ロック解除) または「false」 (ロック) に設定してください。
リクエストを送信します。
ユーザーに関する情報を取得する - Users/GET
Postmanを開き、HTTPメソッドをGETに設定します。
ノード内のすべてのユーザーに関する情報については、以下のURLを使用します。
特定のユーザーに関する情報を取得するには、ユーザーIDを指定します。
リクエストを送信します。
ユーザーのフィルタリングにも対応しています。以下はユーザーIDに基づいて検索する例です。
さらに、startIndexとcountを使用してページネーションを使用することもできます。
グループとグループ ID の取得 - Groups/GET
Postmanを開いて新しいGETリクエストを作成します。
URLを設定します。
リクエストを送信します。
予想される応答
応答は、指定されたノードの下にあるすべてのグループの詳細を含むJSONオブジェクトになります。各グループオブジェクト内の「id」フィールドは、グループIDを表します。Keeperでは、グループはKeeperチームオブジェクトによって表されます。IDは KeeperチームUIDです。
単一のグループの情報を取得するには、URLの末尾にグループIDを含めます。https://keepersecurity.com/api/rest/scim/v2/<node_id>/Groups/<group_id>
チームの作成 - Groups/POST
新しいリクエストを作成します。
「New」をクリックしてから、ドロップダウンメニューから「Request」を選択します。
すでに開いている場合は「Request」タブをクリックすることもできます。
HTTPメソッドとURLを設定します。
ドロップダウンメニューを使用してHTTPメソッドをPOSTに設定します。
チームを追加するためのURLを入力します。
ボディを設定します。
URL フィールドの下にある「Boday」タブをクリックします。
rawを選択し、JSON形式を選択します。
以下のように作成するチームの詳細を記載したJSONボディを追加します。
「Team Name」を任意のチーム名に置き換えます。
リクエストを送信します。
Postmanの「Send」ボタンをクリックしてリクエストを実行します。
チームの削除 - Groups/DELETE
HTTPメソッドとURLを設定します。
ドロップダウンメニューを使用して、HTTPメソッドをDELETEに設定します。
URLを設定します。
リクエストを送信します。
チームへのユーザーの追加または削除 - Users/PATCH
HTTPメソッドとURLを設定します。
ドロップダウンメニューを使用して、HTTPメソッドをPATCHに設定します。
URLを設定します。
<node_id>を実際のノードIDに、<group_id>を更新したいチームのIDに置き換えます。
ボディを設定します。
URLフィールドの下の「Body」タブをクリックします。
rawを選択し、JSON形式を選択します。
以下のようにチームに追加するユーザーの詳細を記載したJSONボディを追加します。
「op」の値を「add」に変更すると、ユーザーがチームに追加されます。値を「remove」に変更すると、ユーザーがチームから削除されます。
リクエストを送信します。
ユーザー属性の更新 - Users/PUT
新しいリクエストを作成します。
「New」をクリックし、ドロップダウンメニューから「Request」を選択します。
すでに開いている場合は、「Request」タブをクリックすることもできます。
HTTPメソッドとURLを設定します。
HTTPメソッドをPUTに設定します。
以下のURLを使用します。
ボディを設定します。
URLフィールドの下の「Body」タブをクリックします。
rawを選択し、JSON形式を選択します。
以下は、ユーザー情報を更新するためのJSONボディの例です。
「active」フラグをfalseに変更するとユーザーアカウントがロックされ、trueに変更するとアカウントのロックが解除されます。
リクエストを送信します。
Postmanの「Send」ボタンをクリックしてリクエストを実行します。
ユーザー属性の更新 - Users/Patch
SCIM関連エンドポイント/GET
HTTPメソッドをGetに設定します。
以下のURLを使用します。
ServiceProviderConfig / ResourceTypes (User/Groups) / Schemas
Last updated