Module redmine_api::api::users

source · [−]
Expand description

Users Rest API Endpoint definitions

Redmine Documentation

  • 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

CreateUser
The endpoint to create a Redmine user
CreateUserBuilder
Builder for CreateUser.
DeleteUser
The endpoint to delete a Redmine user
DeleteUserBuilder
Builder for DeleteUser.
GetUser
The endpoint for a specific user
GetUserBuilder
Builder for GetUser.
ListUsers
The endpoint for all users
ListUsersBuilder
Builder for ListUsers.
UpdateUser
The endpoint to update an existing Redmine user
UpdateUserBuilder
Builder for UpdateUser.
User
a type for user to use as an API return type
UserEssentials
a minimal type for Redmine users used in other Redmine objects (e.g. issue author)
UserWrapper
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
UserWrapperWithSendInformation
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
UsersWrapper
helper struct for outer layers with a users field holding the inner data

Enums

CreateUserBuilderError
Error type for CreateUserBuilder
DeleteUserBuilderError
Error type for DeleteUserBuilder
GetUserBuilderError
Error type for GetUserBuilder
ListUsersBuilderError
Error type for ListUsersBuilder
MailNotificationOptions
Possible values for mail notification options for a user
UpdateUserBuilderError
Error type for UpdateUserBuilder
UserInclude
The types of associated data which can be fetched along with a user
UserStatus
The user status values for filtering