Planka icon

Planka

Interact with Planka API

Overview

The Update User Username operation for the 👤 USER resource in this n8n node allows you to change the username of an existing user in your Planka instance. This is useful for administrative tasks such as correcting typos, updating usernames due to policy changes, or handling user requests for a new username.

Practical scenarios:

  • An employee changes their preferred username and requests an update.
  • Standardizing usernames across your organization.
  • Correcting mistakes made during user creation.

Properties

Name Type Meaning
User ID string The unique identifier of the user whose username will be updated. Required.
Username string The new username to assign to the user. Required.

Output

The output will be a JSON object containing the updated user information as returned by the Planka API after the username change. The structure typically includes fields such as id, name, email, username, and other user attributes.

Example output:

{
  "id": "123",
  "name": "John Doe",
  "email": "john@example.com",
  "username": "newusername",
  // ...other user fields
}

If an error occurs and "Continue On Fail" is enabled, the output will include an error message:

{
  "error": "Error message here"
}

Dependencies

  • Planka API: Requires access to a running Planka instance with API support.
  • API Credentials: You must configure the plankaApi credentials in n8n for authentication.

Troubleshooting

Common issues:

  • Invalid User ID: If the provided User ID does not exist, the API will return an error.
  • Username Already Taken: Attempting to set a username that already exists may result in a conflict error from the API.
  • Missing Required Fields: Both User ID and Username are required; omitting either will cause the node to fail.
  • Authentication Errors: Incorrect or missing API credentials will prevent the request from succeeding.

Error messages:

  • "User not found": Check that the User ID is correct.
  • "Username already exists": Choose a different username.
  • "Unauthorized": Verify your API credentials in n8n.

Links and References

Discussion