ドライブおよびフォト サービスでは、ドライブおよびフォト サービスが提供するデフォルト クライアントでグループを管理できます。また、このトピックで説明されている API 操作を呼び出して、グループを管理することもできます。
基本概念
グループは、企業の部門と考えることができます。ユーザーまたは他のグループをグループに追加できます。
グループのメンバーは、ユーザーまたはグループにすることができます。
次の図は、サンプル企業の構造を示しています。
1 人のユーザーを複数のグループに追加できます。ユーザーを 10 個以下のグループに追加することをお勧めします。そうしないと、クエリのパフォーマンスが低下する可能性があります。
グループを作成するときに、親グループを指定できます。グループは、作成後に移動することはできません。グループを作成するときに親グループを指定しない場合、作成したグループはルート グループとして機能します。
グループには最大 10 レベルを含めることができます。
API 呼び出しの例
1. グループを作成する
ルート グループを作成する場合は、is_root パラメーターを true に設定します。ルート グループを作成しない場合は、parent_group_id パラメーターを指定し、is_root パラメーターを false に設定する必要があります。
リクエストの例
// ルートグループを作成します。
{
"group_name": "Enterprise A",
"is_root": true
}
// Enterprise A に R&D 部門を作成します。
{
"group_name": "R&D department",
"is_root": false,
"parent_group_id": "testParentGroupId"
}正常なレスポンスの例
{
"domain_id": "testDomainId",
"group_id": "testGroupId",
"group_name": "testGroupName",
"description": "",
"created_at": 1677335855709,
"updated_at": 1677335855709,
"creator": "",
"permission": null
}2. グループ メンバーを一覧表示する
すべてのルート グループを一覧表示する場合は、group_id パラメーターを指定しないでください。
リクエストの例
{
"group_id": "testGroupId",
"limit": 100
}正常なレスポンスの例
{
"group_items": [
{
"domain_id": "testDomainId",
"group_id": "testGroupId",
"group_name": "R&D department",
"description": "",
"created_at": 1677336367210,
"updated_at": 1677336367210,
"creator": "",
"permission": null
}
],
"user_items": [],
"next_marker": ""
}3. グループにユーザーを追加する
この操作を呼び出して、グループにユーザーのみを追加できます。親グループにグループを追加するには、子グループを作成するときに parent_group_id パラメーターを指定します。
リクエストの例
{
"group_id": "testGroupId",
"member_id": "testMemberId",
"member_type": "user"
}レスポンスの例
204 NoContent
4. グループからユーザーを削除する
この操作を呼び出して、グループからユーザーのみを削除できます。グループを削除する場合は、グループからすべてのメンバーを削除してから、グループを削除する必要があります。
リクエストの例
{
"group_id": "testGroupId",
"member_id": "testMemberId",
"member_type": "user"
}レスポンスの例
204 NoContent
5. グループを削除する
この操作を呼び出して、メンバーがいないグループのみを削除できます。
リクエストの例
{
"group_id": "testGroupId"
}レスポンスの例
204 NoContent