GET /api/usergroups
ユーザーグループの一覧

Params

Param Name Description
search
Optional

結果をフィルタ


Value:

Must be String

order
Optional

結果をソート


Value:

Must be String

page
Optional

結果をページ分割


Value:

Must be String

per_page
Optional

リクエストあたりのエントリ数


Value:

Must be String


GET /api/usergroups/:id
ユーザーグループの確認

Params

Param Name Description
id
Required

Value:

Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/usergroups
ユーザーグループの作成

Params

Param Name Description
usergroup
Required

Value:

Must be a Hash

usergroup[name]
Required

Value:

Must be String

usergroup[user_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be an array of any type

usergroup[usergroup_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be an array of any type

usergroup[role_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be an array of any type


PUT /api/usergroups/:id
ユーザーグループの更新

Params

Param Name Description
id
Required

Value:

Must be String

usergroup
Required

Value:

Must be a Hash

usergroup[name]
Optional

Value:

Must be String

usergroup[user_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be an array of any type

usergroup[usergroup_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be an array of any type

usergroup[role_ids]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be an array of any type


DELETE /api/usergroups/:id
ユーザーグループの削除

Params

Param Name Description
id
Required

Value:

Must be String