This commit is contained in:
10
dist/services/UserService.js
vendored
10
dist/services/UserService.js
vendored
@@ -5,7 +5,7 @@ const request_1 = require("../core/request");
|
||||
class UserService {
|
||||
/**
|
||||
* Get all
|
||||
* Lists all users.
|
||||
* Lists all users. <br> This includes their groups and permissions directly granted to them (if existing/associated).
|
||||
* @returns User
|
||||
* @throws ApiError
|
||||
*/
|
||||
@@ -18,7 +18,7 @@ class UserService {
|
||||
}
|
||||
/**
|
||||
* Post
|
||||
* Create a new user object (id will be generated automagicly).
|
||||
* Create a new user. <br> If you want to grant permissions to the user you have to create them seperately by posting to /api/permissions after creating the user.
|
||||
* @param requestBody CreateUser
|
||||
* @returns any
|
||||
* @throws ApiError
|
||||
@@ -33,7 +33,7 @@ class UserService {
|
||||
}
|
||||
/**
|
||||
* Get one
|
||||
* Returns a user of a specified id (if it exists)
|
||||
* Lists all information about the user whose id got provided. <br> Please remember that only permissions granted directly to the user will show up here, not permissions inherited from groups.
|
||||
* @param id
|
||||
* @returns User
|
||||
* @throws ApiError
|
||||
@@ -47,7 +47,7 @@ class UserService {
|
||||
}
|
||||
/**
|
||||
* Put
|
||||
* Update a user object (id can't be changed).
|
||||
* Update the user whose id you provided. <br> To change the permissions directly granted to the user please use /api/permissions instead. <br> Please remember that ids can't be changed.
|
||||
* @param id
|
||||
* @param requestBody UpdateUser
|
||||
* @returns User
|
||||
@@ -63,7 +63,7 @@ class UserService {
|
||||
}
|
||||
/**
|
||||
* Remove
|
||||
* Delete a user runner (if it exists).
|
||||
* Delete the user whose id you provided. <br> If there are any permissions directly granted to the user they will get deleted as well. <br> If no user with this id exists it will just return 204(no content).
|
||||
* @param id
|
||||
* @param force
|
||||
* @returns User
|
||||
|
||||
Reference in New Issue
Block a user