Redmine icon

Redmine

Consume Redmine API

Overview

This node integrates with the Redmine API to manage users, projects, and issues. Specifically for the User - Create operation, it allows creating a new user in a Redmine instance by providing essential user details such as login, first name, last name, email, and password. Additional optional fields can be set to customize the user's properties further.

Common scenarios where this node is beneficial include automating user onboarding processes, synchronizing user accounts from other systems into Redmine, or bulk-creating users based on external data sources.

Practical example: Automatically create a new Redmine user when a new employee joins your company, setting their login credentials and notification preferences without manual intervention.

Properties

Name Meaning
Login The username of the user (required).
First Name The first name of the user (required).
Last Name The last name of the user (required).
Email The email address of the user (required).
Password The password for the user account (required).
Additional Fields Optional extra settings for the user:
- Admin Whether the user has administrator privileges (boolean).
- Authentication Source ID ID of the authentication source to link the user to (string).
- Custom Fields One or more custom fields with IDs and values to assign to the user.
- Email Notifications User's email notification preference; options are: "All", "None", "Only Assigned", "Only For My Events", "Only Owner".
- Must Change Password Whether the user must change their password upon next login (boolean).
- Status The status of the user; options are: "Active" (1), "Registered" (2), "Locked" (3).

Output

The node outputs an array of JSON objects representing the results of the create user operations. Each output item contains the response from the Redmine API for the created user, typically including user details such as ID, login, name, email, and any additional fields set.

If an error occurs during creation and the node is configured to continue on failure, the output will contain an object with an error field describing the issue.

The node does not output binary data.

Dependencies

  • Requires access to a Redmine instance with API enabled.
  • Needs an API key credential for authenticating requests to the Redmine API.
  • The Redmine API URL and API key must be configured in the node credentials.

Troubleshooting

  • Common Issues:

    • Invalid or missing API key: The node will fail to authenticate with Redmine.
    • Missing required user fields (login, firstname, lastname, mail, password): The API will reject the request.
    • Incorrect status or email notification option values may cause errors.
    • Network connectivity issues to the Redmine server.
  • Error Messages:

    • Errors returned from the Redmine API will be included in the output if "continue on fail" is enabled.
    • Typical error messages include authentication failures, validation errors for missing or invalid fields, or permission denied if the API key lacks sufficient rights.
  • Resolution:

    • Verify API key validity and permissions.
    • Ensure all required fields are provided and correctly formatted.
    • Check network connectivity and Redmine server availability.
    • Review Redmine user permissions related to user creation.

Links and References

Discussion