ユーザーグループの検索、追加、変更、削除やグループメンバーの追加、削除を実施するためのパラメータは以下のとおりです。
ユーザーグループの検索
| 利用可能なパラメータ | 必須 | 説明 |
| action_group_read | 〇 | 固定値:true |
| name | 検索するグループ名 | |
| displayname | 検索する表示名 | |
| 検索するメールアドレス | ||
| page_size | 一覧を表示させるページのサイズ | |
| page_num | 一覧を表示させるページ番号 |
ユーザーグループの作成
| 利用可能なパラメータ | 必須 | 説明 |
| action_group_create | 〇 | 固定値:true |
| name | 〇 | グループ名 |
| displayname | 〇 | 表示名 ※他グループと重複する値は登録できません。 |
| メールアドレス ※他グループと重複する値は登録できません。 |
||
| description | 説明 | |
| owner[] ※LINE WORKSとの連携時のみ |
グループの所有者のユーザID（配列） | |
| type_office365 ※Microsoft365との連携時のみ |
Microsoft365グループタイプ ・セキュリティーグループ：security ・配布グループ：distribution ・Microsoft365グループ：unified |
|
| 追加属性 | 「システム」-「追加属性」で設定した属性は、”attr_<追加属性の属性名>”をパラメータとして、値を登録して下さい。 |
ユーザーグループの更新
| 利用可能なパラメータ | 必須 | 説明 |
| action_group_update | 〇 | 固定値:true |
| name | 〇 | グループ名 |
| displayname | 〇 | 表示名 ※他グループと重複する値は登録できません。 |
| メールアドレス ※他グループと重複する値は登録できません。 |
||
| description | 説明 | |
| owner[] ※LINE WORKSとの連携時のみ |
グループの所有者のユーザーID（配列） | |
| 追加属性 | 「システム」-「追加属性」で設定した属性は、”attr_<追加属性の属性名>”をパラメータとして、値を登録して下さい。 |
ユーザーグループメンバーの確認
| 利用可能なパラメータ | 必須 | 説明 |
| action_group_readUser | 〇 | 固定値:true |
| name | 〇 | グループID |
| page_size | 一覧を表示させるページのサイズ | |
| page_num | 一覧を表示させるページ番号 |
ユーザーグループメンバーの追加
| 利用可能なパラメータ | 必須 | 説明 |
| action_group_assignUser | 〇 | 固定値:true |
| name | 〇 | グループ名 |
| type | メンバーの種類 (user|group|contact) ※デフォルトはuser |
|
| member[] | 〇 | メンバー（ユーザーのユーザID、ユーザーグループのグループ名、連絡先のメールアドレス）(配列) |
ユーザーグループメンバーの削除
| 利用可能なパラメータ | 必須 | 説明 |
| action_group_deassignUser | 〇 | 固定値:true |
| name | 〇 | グループ名 |
| type | メンバーの種類 (user|group|contact) ※デフォルトはuser |
|
| member[] | 〇 | メンバー（ユーザーのユーザーID、ユーザーグループのグループ名、連絡先のメールアドレス）(配列) |
ユーザーグループの削除
| 利用可能なパラメータ | 必須 | 説明 |
| action_group_delete | 〇 | 固定値:true |
| name | 〇 | グループ名 |