GET /api/usergroups
List all user groups

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
Show a user group

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
Create a user group

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: zh-TW.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: zh-TW.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: zh-TW.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type

PUT /api/usergroups/:id
Update a user group

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: zh-TW.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: zh-TW.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: zh-TW.apipie.nil_allowed">Nil Allowed</span>

Value: Must be an array of any type

DELETE /api/usergroups/:id
Delete a user group

Params

Param Name Description
id
Required

Value: Must be String