グループ管理

グループ管理画面のリファレンスです。画面の項目・操作・制約・必要な権限を、製品の仕様をもとにまとめています。

画面の概要

項目	内容
画面パス	`/groups`
対象となる利用者	一般 / 管理者 / 監査
画面を開くのに必要な権限	`group:manage`

この画面でできること

この画面でできる操作の一覧です。それぞれに必要な権限を併記しています。

操作	必要な権限
グループの一覧を見る	`group:manage`
グループの詳細を見る	`group:manage`
グループを作成する	`group:manage`
グループの名前を変える / 階層を移動する	`group:manage`
グループを削除する	`group:manage`
メンバーの一覧を見る	`group:manage`
メンバーを追加する	`group:manage`
メンバーを外す	`group:manage`

画面に表示される項目

画面の一覧・詳細に出る項目です。項目名は、他システムと連携するときに使う名前でもあります。

グループ

次の操作で扱います。

グループの一覧を見る
グループの詳細を見る
グループを作成する
グループの名前を変える / 階層を移動する

項目	型	必須	説明
`id`	文字列（UUID）	必須	グループ ID
`parentId`	文字列（UUID / null 可）	必須	親グループ ID。null でルート
`name`	文字列	必須	グループ名
`path`	文字列	必須	階層パス（例: /sales/east）
`isRoot`	真偽値	必須	ルートグループか
`memberCount`	整数	必須	所属メンバー数
`depth`	整数	必須	階層の深さ（ルート=0）

メンバー

「メンバーの一覧を見る」で扱います。

項目	型	必須	説明
`userId`	文字列（UUID）	必須	ユーザー ID
`userName`	文字列	必須	ユーザー名
`userEmail`	文字列	必須	メールアドレス

入力する項目

作成・変更の操作で送る項目です。型の欄にある文字数や件数が、そのまま入力の上限になります。

グループの作成

「グループを作成する」で扱います。

項目	型	必須	説明
`parentId`	文字列（UUID）	必須	親グループ ID
`name`	文字列（1〜64 文字）	必須	グループ名

グループの変更

「グループの名前を変える / 階層を移動する」で扱います。

項目	型	必須	説明
`name`	文字列（1〜64 文字）	任意	グループ名
`parentId`	文字列（UUID）	任意	親グループ ID（階層移動）

メンバーの追加

「メンバーを追加する」で扱います。

項目	型	必須	説明
`userIds`	文字列（UUID）の配列（1 件以上）	必須	追加するユーザー ID の配列

絞り込みとページングの指定

一覧の取得時に指定できる値です。画面の検索欄・並び替え・ページ送りがこれに対応します。

指定	型	必須	補足	操作
`limit`	整数（1〜100）	任意	1 リクエストで返す最大件数。既定値 20	メンバーの一覧を見る
`cursor`	文字列	任意	ページングカーソル	メンバーの一覧を見る

制約

この画面でできないこと、気をつけることは次のとおりです。

ルートグループ（一番上のグループ）は、名前の変更も削除もできません。
子グループがあるグループは削除できません。先に子グループを削除してください。
同じ親の下に、同じ名前のグループは作れません。
グループ名は 1〜64 文字です。スラッシュ（/）は使えません。
グループを自分自身の下や、その子グループの下へは移動できません。
グループを削除すると、そのグループのメンバー登録も一緒に消えます。

エラーと識別子

この画面で出るエラーのうち、この機能に固有のものです。認証切れ（401）・権限不足（403）・入力形式の誤り（400）は全画面で共通のため省いています。サポートへ問い合わせるときは、右端の識別子をあわせてお伝えください。

操作	状況	ステータス	識別子
グループを作成する	親グループが存在しない（他テナント含む）	404	`parent_not_found`
グループを作成する	グループ名が命名ルールに違反	400	`invalid_group_name`
グループを作成する	同一親の下に同名グループが既に存在する	409	`duplicate_path`
グループの名前を変える / 階層を移動する	ルートグループを変更しようとした	400	`root_group_immutable`
グループの名前を変える / 階層を移動する	グループ名が命名ルールに違反	400	`invalid_group_name`
グループの名前を変える / 階層を移動する	自分自身または自分の子孫を親に指定した	400	`circular_move`
グループの名前を変える / 階層を移動する	移動先の親グループが存在しない（他テナント含む）	404	`parent_not_found`
グループの名前を変える / 階層を移動する	移動先に同名グループが既に存在する	409	`duplicate_path`
グループを削除する	ルートグループを削除しようとした	400	`root_group_immutable`
グループを削除する	子グループが存在する	400	`group_has_descendants`
メンバーを追加する	グループが存在しない（他テナント含む）	404	`group_not_found`
メンバーを追加する	指定したユーザーの一部または全部が見つからない	404	`user_not_found`
メンバーを外す	グループが存在しない（他テナント含む）	404	`group_not_found`
メンバーを外す	指定したユーザーがグループのメンバーでない	404	`member_not_found`

必要な権限

権限はロールに割り当てます。ロールの設定は管理者が行います。

権限	できること
`group:manage`	グループの作成・変更・削除と、メンバーの追加・除外ができます。

操作手順のガイド

実際の操作手順は次の記事で説明しています。

グループを管理する