このトピックでは、グループとメンバーを管理するために使用されるメソッドについて説明します。
IPDSRequestConfig タイプの options パラメーターは、axios のリクエスト設定オプションに基づいてカプセル化されています。詳細は、AxiosRequestConfig を参照してください。
createGroup
このメソッドを呼び出すには、管理者権限が付与されているか、グループ管理者である必要があります。
グループを作成します。
const result = await client.createGroup(params, options)サンプルコード
await client.createGroup({
group_name: 'test',
description: '',
is_root: true
})リクエストパラメーター
パラメーター | タイプ | 必須 | 説明 |
params | ICreatGroupReq | はい | グループに関する情報。 |
options | IPDSRequestConfig | その他のリクエストパラメーター。 |
ICreatGroupReq
パラメーター | タイプ | 必須 | 説明 |
group_name | string | はい | グループの名前。 |
description | string | グループの説明。 | |
is_root | boolean | グループがルートグループかどうかを指定します。 | |
parent_group_id | string | 親グループID。parent_group_id と is_root パラメーターのいずれか一方のみを指定できます。 |
レスポンスパラメーター
パラメーター | タイプ | 必須 | 説明 |
result | IGroupItem | はい | 返された結果。 |
IGroupItem
パラメーター | タイプ | 必須 | 説明 |
domain_id | string | ドメインID。 | |
group_id | string | グループID。 | |
group_name | string | グループの名前。 | |
description | string | グループの説明。 | |
created_at | number | グループが作成された時刻。 | |
updated_at | number | グループが最後に更新された時刻。 |
deleteGroup
このメソッドを呼び出すには、管理者権限が付与されているか、グループ管理者である必要があります。
グループを削除します。
await client.deleteGroup(params, options)サンプルコード
await client.deleteGroup({
group_id: '0cbfe8de7d7645ea835b1b1a91101e4d'
})リクエストパラメーター
パラメーター | タイプ | 必須 | 説明 |
params | Object | はい | リクエストパラメーター。 |
options | IPDSRequestConfig | その他のリクエストパラメーター。 |
params
パラメーター | タイプ | 必須 | 説明 |
group_id | string | はい | グループID。 |
レスポンスパラメーター
なし
updateGroup
このメソッドを呼び出すには、管理者権限が付与されているか、グループ管理者である必要があります。
グループを更新します。
await client.updateGroup(params, options)サンプルコード
await client.updateGroup({
group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
group_name: 'new_name',
description: 'test'
})リクエストパラメーター
パラメーター | タイプ | 必須 | 説明 |
params | IUpdateGroupReq | はい | リクエストパラメーター。 |
options | IPDSRequestConfig | その他のリクエストパラメーター。 |
IUpdateGroupReq
パラメーター | タイプ | 必須 | 説明 |
group_id | string | はい | グループID。 |
group_name | string | グループの名前。 | |
description | string | グループがルートグループかどうかを指定します。 |
レスポンスパラメーター
パラメーター | タイプ | 必須 | 説明 |
result | IGroupItem | はい | 返された結果。 |
getGroup
グループに関する情報をクエリします。
const result = await client.getGroup(params, options)サンプルコード
const groupInfo = await client.getGroup({
group_id: '0cbfe8de7d7645ea835b1b1a91101e4d'
})リクエストパラメーター
パラメーター | タイプ | 必須 | 説明 |
params | Object | はい | リクエストパラメーター。 |
options | IPDSRequestConfig | その他のリクエストパラメーター。 |
params
パラメーター | タイプ | 必須 | 説明 |
group_id | string | はい | グループID。 |
レスポンスパラメーター
パラメーター | タイプ | 必須 | 説明 |
result | IGroupItem | はい | 返された結果。 |
listGroups
グループのリストをクエリします。
await client.listGroups(params, options)サンプルコード
await client.listGroups({
limit: 100,
marker:''
})リクエストパラメーター
パラメーター | タイプ | 必須 | 説明 |
params | IListReq | はい | リクエストパラメーター。 |
options | IPDSRequestConfig | その他のリクエストパラメーター。 |
IListReq
パラメーター | タイプ | 必須 | 説明 |
limit | number | 返すエントリの最大数。有効な値：1～100。デフォルト値：100。 | |
marker | string | クエリの開始識別子。 |
レスポンスパラメーター
パラメーター | タイプ | 必須 | 説明 |
result | IListRes | はい | 返された結果。 |
IListRes
パラメーター | タイプ | 必須 | 説明 |
items | IGroupItem[] | グループ。 | |
next_marker | string | 次のクエリの開始識別子。 |
searchGroups
グループのリストをクエリし、グループが最後に更新された時刻に基づいて降順にソートします。
await client.searchGroups(params, options)const {items=[]} = await client.listGroups({
limit: 100,
marker:'',
group_name: 'test_group_name'
})リクエストパラメーター
パラメーター | タイプ | 必須 | 説明 |
params | Object | はい | リクエストパラメーター。 |
options | IPDSRequestConfig | その他のリクエストパラメーター。 |
params
パラメーター | タイプ | 必須 | 説明 |
limit | number | 返すエントリの最大数。有効な値：1～100。デフォルト値：100。 | |
marker | string | クエリの開始識別子。 | |
group_name | string | グループの名前。 |
レスポンスパラメーター
パラメーター | タイプ | 必須 | 説明 |
result | IListRes | はい | 返された結果。 |
IListRes
パラメーター | タイプ | 必須 | 説明 |
items | IGroupItem[] | グループ。 | |
next_marker | string | 次のクエリの開始識別子。 |
listGroupMembers
このメソッドを呼び出すには、管理者権限が付与されているか、グループ管理者である必要があります。
グループ内の子グループまたはユーザーをクエリします。
await client.listGroupMembers(params, options)サンプルコード
await client.listGroupMembers({
limit: 100,
marker:'',
group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
member_type: 'group'
})リクエストパラメーター
パラメーター | タイプ | 必須 | 説明 |
params | Object | はい | リクエストパラメーター。 |
options | IPDSRequestConfig | その他のリクエストパラメーター。 |
params
パラメーター | タイプ | 必須 | 説明 |
limit | number | 返すエントリの最大数。有効な値：1～100。デフォルト値：100。 | |
marker | string | クエリの開始識別子。 | |
group_id | string | はい | グループID。 |
member_type | string | はい | メンバーのタイプ。有効な値：user および group。 |
レスポンスパラメーター
パラメーター | タイプ | 必須 | 説明 |
result | IListGroupMembersRes | はい | 返された結果。 |
IListGroupMembersRes
パラメーター | タイプ | 説明 |
user_items | IUserItem[] | ユーザー。 |
group_items | IGroupItem[] | グループ。 |
next_marker | string | 次のクエリの開始識別子。 |
addGroupMember
このメソッドを呼び出すには、管理者権限が付与されているか、グループ管理者である必要があります。
グループにユーザーをメンバーとして追加します。
const result = await client.addGroupMember(params, options)サンプルコード
await client.addGroupMember({
member_id: 'test',
member_type: 'user',
group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
})リクエストパラメーター
パラメーター | タイプ | 必須 | 説明 |
params | IAddGroupMemberReq | はい | リクエストパラメーター。 |
options | IPDSRequestConfig | その他のリクエストパラメーター。 |
IAddGroupMemberReq
パラメーター | タイプ | 必須 | 説明 |
group_id | string | はい | グループID。 |
member_id | string | はい | ユーザーID。 |
member_type | string | はい | メンバーのタイプ。 値を user に設定します。 子グループを作成するには、createGroup メソッドを呼び出します。 |
レスポンスパラメーター
なし
removeGroupMember
このメソッドを呼び出すには、管理者権限が付与されているか、グループ管理者である必要があります。
グループからメンバーを削除します。
await client.removeGroupMember(params, options)サンプルコード
await client.removeGroupMember({
member_id: 'test',
member_type: 'user',
group_id: '0cbfe8de7d7645ea835b1b1a91101e4d',
})リクエストパラメーター
パラメーター | タイプ | 必須 | 説明 |
params | IRemoveGroupMemberReq | はい | リクエストパラメーター。 |
options | IPDSRequestConfig | その他のリクエストパラメーター。 |
IRemoveGroupMemberReq
パラメーター | タイプ | 必須 | 説明 |
group_id | string | はい | グループID。 |
member_id | string | はい | ユーザーID。 |
member_type | string | はい | メンバーのタイプ。グループからはユーザーのみを削除できます。子グループを削除するには、deleteGroup メソッドを呼び出します。
|
レスポンスパラメーター
なし