Expand description
Users Rest API Endpoint definitions
-
all users endpoint
- status filter
- name filter
- group_id filter
-
specific user endpoint
- by user id
- current
- create user endpoint
- update user endpoint
- delete user endpoint
Structs§
- Create
User - The endpoint to create a Redmine user
- Create
User Builder - Builder for
CreateUser. - Delete
User - The endpoint to delete a Redmine user
- Delete
User Builder - Builder for
DeleteUser. - GetUser
- The endpoint for a specific user
- GetUser
Builder - Builder for
GetUser. - List
Users - The endpoint for all users
- List
Users Builder - Builder for
ListUsers. - Update
User - The endpoint to update an existing Redmine user
- Update
User Builder - Builder for
UpdateUser. - User
- a type for user to use as an API return type
- User
Essentials - a minimal type for Redmine users used in other Redmine objects (e.g. issue author)
- User
Wrapper - A lot of APIs in Redmine wrap their data in an extra layer, this is a helper struct for outer layers with a user field holding the inner data
- User
Wrapper With Send Information - a special version of the UserWrapper to use with CreateUser and UpdateUser because Redmine puts the send_information flag outside the user object for some reason
- Users
Wrapper - helper struct for outer layers with a users field holding the inner data
Enums§
- Create
User Builder Error - Error type for CreateUserBuilder
- Delete
User Builder Error - Error type for DeleteUserBuilder
- GetUser
Builder Error - Error type for GetUserBuilder
- List
Users Builder Error - Error type for ListUsersBuilder
- Mail
Notification Options - Possible values for mail notification options for a user
- Update
User Builder Error - Error type for UpdateUserBuilder
- User
Include - The types of associated data which can be fetched along with a user
- User
Status - The user status values for filtering