Redmine icon

Redmine

Consume Redmine API

Overview

This node integrates with the Redmine API to update user information. It allows modifying various user attributes such as administrative status, authentication source, email notification preferences, password change requirements, and account status. This is useful in scenarios where you need to programmatically manage user accounts in Redmine, for example, updating user roles after a promotion, changing notification settings based on project involvement, or locking accounts when users leave an organization.

Practical examples:

  • Automatically lock a user account when they are no longer active.
  • Change a user's email notification preferences to reduce inbox clutter.
  • Set a flag requiring users to change their password on next login for security compliance.

Properties

Name Meaning
User ID The unique identifier of the user to update.
Additional Fields A collection of optional fields to update for the user:
- Admin Whether the user should have administrator privileges (true/false).
- Authentication Source ID The ID of the external authentication source linked to the user.
- Custom Fields Custom key-value pairs representing additional user-specific fields defined in Redmine.
- Email Notifications Options for email notifications the user receives: all, none, only assigned issues, only own events, or only owned items.
- Must Change Password Whether the user must change their password upon next login (true/false).
- Status The user's account status: Active, Registered, or Locked.

Output

The node outputs JSON data representing the updated user object returned by the Redmine API. This typically includes the user's current attributes after the update operation. If the update fails, the output may contain an error message describing the issue.

No binary data output is produced by this node.

Dependencies

  • Requires connection to a Redmine instance via its REST API.
  • Needs an API key credential for authentication with the Redmine server.
  • The Redmine URL and API key must be configured in the node credentials.

Troubleshooting

  • Common Issues:
    • Invalid or missing User ID will cause the update to fail.
    • Incorrect API key or insufficient permissions can result in authorization errors.
    • Providing invalid values for fields like status or email notifications may cause validation errors.
  • Error Messages:
    • Errors from the Redmine API are passed through; typical messages include "User not found," "Unauthorized," or "Invalid parameters."
  • Resolutions:
    • Verify that the User ID exists in Redmine.
    • Ensure the API key has sufficient rights to update users.
    • Double-check field values against allowed options.

Links and References

Discussion