This commit is contained in:
10
dist/services/UserGroupService.js
vendored
10
dist/services/UserGroupService.js
vendored
@@ -5,7 +5,7 @@ const request_1 = require("../core/request");
|
||||
class UserGroupService {
|
||||
/**
|
||||
* Get all
|
||||
* Lists all usergroups.
|
||||
* Lists all groups. <br> The information provided might change while the project continues to evolve.
|
||||
* @returns UserGroup
|
||||
* @throws ApiError
|
||||
*/
|
||||
@@ -18,7 +18,7 @@ class UserGroupService {
|
||||
}
|
||||
/**
|
||||
* Post
|
||||
* Create a new usergroup object (id will be generated automagicly).
|
||||
* Create a new group. <br> If you want to grant permissions to the group you have to create them seperately by posting to /api/permissions after creating the group.
|
||||
* @param requestBody CreateUserGroup
|
||||
* @returns any
|
||||
* @throws ApiError
|
||||
@@ -33,7 +33,7 @@ class UserGroupService {
|
||||
}
|
||||
/**
|
||||
* Get one
|
||||
* Returns a usergroup of a specified id (if it exists)
|
||||
* Lists all information about the group whose id got provided. <br> The information provided might change while the project continues to evolve.
|
||||
* @param id
|
||||
* @returns UserGroup
|
||||
* @throws ApiError
|
||||
@@ -47,7 +47,7 @@ class UserGroupService {
|
||||
}
|
||||
/**
|
||||
* Put
|
||||
* Update a usergroup object (id can't be changed).
|
||||
* Update the group whose id you provided. <br> To change the permissions granted to the group please use /api/permissions instead. <br> Please remember that ids can't be changed.
|
||||
* @param id
|
||||
* @param requestBody UserGroup
|
||||
* @returns UserGroup
|
||||
@@ -63,7 +63,7 @@ class UserGroupService {
|
||||
}
|
||||
/**
|
||||
* Remove
|
||||
* Delete a specified usergroup (if it exists).
|
||||
* Delete the group whose id you provided. <br> If there are any permissions directly granted to the group they will get deleted as well. <br> Users associated with this group won't get deleted - just deassociated. <br> If no group with this id exists it will just return 204(no content).
|
||||
* @param id
|
||||
* @param force
|
||||
* @returns ResponseUserGroup
|
||||
|
||||
Reference in New Issue
Block a user