本ページでは、Keeperテナントにユーザーをプロビジョニングするための一般的なAPIプラットフォームであるPostmanの使用方法を記載しました。
環境の設定
メソッド: GET、POST、DELETE、PATCH 、PUT
URL: https://keepersecurity.com/api/rest/scim/v2/<node_id>
ユーザーの追加 - Users/POST
ドロップダウンメニューを使用してPOST にHTTPメソッドを設定します。
https://keepersecurity.com/api/rest/scim/v2/<node_id>/Users
URLフィールドの下の「Body」タブをクリックします。
以下のように追加するユーザーの詳細を記載したJSONボディを追加します。
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"userName": "<user_email>",
"displayName": "<user_name>",
"externalId": "",
"name": {
"familyName": "<first_name>",
"givenName": "<last_name>"
},
"emails":[
{
"value":"email@domain.com"
}
],
"roles": "<role_ids>",
"groups":[
{
"value":"<group_id>",
"$ref":"http://keepersecurity.com/api/rest/scim/v2/<node_id>/<group_id>/scim/Groups",
"display":"<team_name>"
}
]
}
レスポンスHTTPコード
ユーザーのロック/ロック解除 - Users/PATCH
メソッドをPATCHに設定し、URLを以下のように設定します。
https://keepersecurity.com/api/rest/scim/v2/<node_id>/Users/<user_id>
以下のように追加するユーザーの詳細を記載したJSONボディを追加します。
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "Replace",
"path": "active",
"value": "true"
}
]
}
Postmanを開き、HTTPメソッドをGETに設定します。
ノード内のすべてのユーザーに関する情報については、以下のURLを使用します。
https://keepersecurity.com/api/rest/scim/v2/<node_id>/Users
特定のユーザーに関する情報を取得するには、ユーザーIDを指定します。
https://keepersecurity.com/api/rest/scim/v2/<node_id>/Users/<user_id>
ユーザーのフィルタリングにも対応しています。以下はユーザーIDに基づいて検索する例です。
https://keepersecurity.com/api/rest/scim/v2/<node_ID>/Users?filter=id+eq+%22<user_ID>%22
さらに、startIndexとcountを使用してページネーションを使用することもできます。
https://keepersecurity.com/api/rest/scim/v2/<node_id>/Users?startIndex=2&count=200
グループとグループ ID の取得 - Groups/GET
Postmanを開いて新しいGETリクエストを作成します。
https://keepersecurity.com/api/rest/scim/v2/<node_id>/Groups
予想される応答
応答は、指定されたノードの下にあるすべてのグループの詳細を含むJSONオブジェクトになります。各グループオブジェクト内の「id」フィールドは、グループIDを表します。Keeperでは、グループはKeeperチームオブジェクトによって表されます。IDは KeeperチームUIDです。
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": 2,
"Resources": [
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"id": "group_id_1",
"displayName": "Group 1",
"members": []
},
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group"
],
"id": "group_id_2",
"displayName": "Group 2",
"members": []
}
]
}
チームの作成 - Groups/POST
「New」をクリックしてから、ドロップダウンメニューから「Request」を選択します。
すでに開いている場合は「Request」タブをクリックすることもできます。
ドロップダウンメニューを使用してHTTPメソッドをPOSTに設定します。
https://keepersecurity.com/api/rest/scim/v2/<node_id>/Groups
URL フィールドの下にある「Boday」タブをクリックします。
以下のように作成するチームの詳細を記載したJSONボディを追加します。
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:Group",
"http://schemas.microsoft.com/2006/11/ResourceManagement/ADSCIM/Group"
],
"displayName": "<team_name>",
"externalId": "dfe9166c-57f9-417d-83a6-072b5a56a4fe",
"members": [
{
"value": "<user_id>",
"$ref": "https://keepersecurity.com/api/rest/scim/v2/<node_id>/Users/<user_id>",
"display": "<team_name>"
}
]
}
Postmanの「Send」ボタンをクリックしてリクエストを実行します。
チームの削除 - Groups/DELETE
ドロップダウンメニューを使用して、HTTPメソッドをDELETEに設定します。
https://keepersecurity.com/api/rest/scim/v2/<node_id>/Groups/<group_id>
チームへのユーザーの追加または削除 - Users/PATCH
ドロップダウンメニューを使用して、HTTPメソッドをPATCHに設定します。
https://keepersecurity.com/api/rest/scim/v2/<node_id>/Groups/<group_id>
URLフィールドの下の「Body」タブをクリックします。
以下のようにチームに追加するユーザーの詳細を記載したJSONボディを追加します。
{
"Operations": [
{
"op": "add",
"path": "members",
"value": [
{
"value": "<user_id>"
}
]
}
]
}
ユーザー属性の更新 - Users/PUT
「New」をクリックし、ドロップダウンメニューから「Request」を選択します。
すでに開いている場合は、「Request」タブをクリックすることもできます。
https://keepersecurity.com/api/rest/scim/v2/<node_id>/Users/<user_id>
URLフィールドの下の「Body」タブをクリックします。
以下は、ユーザー情報を更新するためのJSONボディの例です。
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"userName": "email@domain.com",
"displayName": "<Desired display name>",
"externalId":
"name": {
"familyName": "<First Name>",
"givenName": "<Last Name>"
},
"emails": [
{
"value": "<email@domain.com>",
"primary": true
}
],
"roles":"none" | "123,432,4324,654",
"groups":[
{
"value":"<group_id>",
"$ref":"http://keepersecurity.com/api/rest/scim/v2/<node_id>/<group_id>/scim/Groups",
"display":"<group_name>"}
}
]
"active": true
}
「active」フラグをfalseに変更するとユーザーアカウントがロックされ、trueに変更するとアカウントのロックが解除されます。
Postmanの「Send」ボタンをクリックしてリクエストを実行します。
ユーザー属性の更新 - Users/Patch
{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:PatchOp"
],
"Operations": [
{
"op": "replace",
"path": "userName",
"value": "<user_name>"
},
{
"op": "replace",
"path": "displayName",
"value": "<display_name>"
},
{
"op": "replace",
"path": "externalId",
"value": "<external_Id>"
},
{
"op": "replace",
"path": "name.familyName",
"value": "<last_name>"
},
{
"op": "replace",
"path": "name.givenName",
"value": "<first_name>"
},
{
"op": "replace",
"path": "active",
"value": false
},
{
"op": "add",
"path": "groups",
"value": [
{
"$ref": "https://example.com/v2/Users/1743756723210",
"value": "<group_id>"
}
]
},
{
"op": "remove",
"path": "groups",
"value": [
{
"$ref": "https://example.com/v2/Users/<user_id>",
"value": "<group_id>"
}
]
}
]
}
ServiceProviderConfig / ResourceTypes (User/Groups) / Schemas
https://keepersecurity.com/api/rest/scim/v2/<node_id>/ServiceProviderConfig
https://keepersecurity.com/api/rest/scim/v2/<node_id>/ResourceTypes/User
https://keepersecurity.com/api/rest/scim/v2/<node_id>/ResourceTypes/Group
https://keepersecurity.com/api/rest/scim/v2/<node_id>/Schemas/urn:ietf:params:scim:schemas:core:2.0:User
https://keepersecurity.com/api/rest/scim/v2/<node_id>/Schemas
Last updated
