mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node operation updates an existing SSH SFTP user in the mittwald mStudio system via its API. It allows modifying various attributes of the SFTP user such as access level, active status, description, directories they can access, expiration date, password, and public keys.

Typical use cases include:

  • Changing permissions for an SFTP user from read-only to full access or vice versa.
  • Activating or deactivating an SFTP user account.
  • Updating the list of directories the user can access.
  • Setting or extending the expiration date of the user's access.
  • Changing the user's password or updating their SSH public keys.

For example, a hosting administrator might use this node to quickly update an SFTP user's access rights after a project requirement changes, or to disable access when a contractor leaves.

Properties

Name Meaning
Sftp User Id The unique identifier of the SFTP user to be updated.
Access Level The permission level granted to the user. Options: "Read" (read-only), "Full" (full access).
Active Whether the SFTP user is active (true) or inactive (false).
Description A textual description or note about the SFTP user.
Directories JSON array specifying directories the user has access to.
Expires At Expiration date/time string indicating when the user's access should expire.
Password The password for the SFTP user.
Public Keys JSON array of SSH public keys associated with the user for key-based authentication.

Output

The node outputs JSON data representing the updated SFTP user object returned by the mittwald mStudio API. This typically includes all current properties of the user after the update, such as ID, access level, active status, directories, expiration, and keys.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the mittwald mStudio API.
  • The node uses the base URL https://api.mittwald.de and expects JSON content-type headers.
  • No other external dependencies are indicated.

Troubleshooting

  • Invalid Sftp User Id: If the provided user ID does not exist, the API will likely return a "not found" error. Verify the ID before running the node.
  • Malformed JSON in Directories or Public Keys: Since these fields expect JSON input, invalid JSON syntax will cause parsing errors. Ensure valid JSON format.
  • Authentication Errors: Missing or incorrect API credentials will result in authorization failures. Confirm the API key is correctly configured.
  • Invalid Access Level: Only "read" or "full" are accepted values. Using other values may cause validation errors.
  • Expired or Incorrect Date Format in Expires At: The expiration date must be in a valid string format recognized by the API; otherwise, the update may fail.

Links and References

Discussion