mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node operation allows a contributor to rotate the secret for a specific extension instance within a marketplace environment. Rotating the secret is typically done to enhance security by invalidating old credentials and generating new ones, ensuring that only authorized parties can access or manage the extension instance.

Common scenarios include:

  • When a contributor suspects that the current secret has been compromised.
  • Routine security maintenance to periodically update secrets.
  • After changes in team members or permissions requiring credential updates.

Practical example: A developer managing an extension on a marketplace wants to rotate the secret key used by their extension instance to prevent unauthorized access after a team member leaves.

Properties

Name Meaning
Contributor Id The unique identifier of the contributor requesting the secret rotation.
Extension Id The unique identifier of the extension for which the secret is being rotated.
Extension Instance Id The unique identifier of the specific extension instance whose secret will be rotated.
Allow Webhook Failure Boolean flag indicating whether webhook failures should be tolerated (true) or not (false).

Output

The node outputs JSON data representing the result of the secret rotation operation. This typically includes confirmation details such as success status, updated secret information, or error messages if the operation failed.

If the node supports binary data output (not indicated here), it would generally relate to downloadable credentials or certificates, but this is not evident from the provided code.

Dependencies

  • Requires an API key credential for authentication with the mittwald mStudio API.
  • Connects to the mittwald API endpoint at https://api.mittwald.de.
  • Uses the bundled OpenAPI specification (openapi.json) to define request and response structures.
  • Requires proper configuration of the API credential within n8n to authorize requests.

Troubleshooting

  • Common issues:

    • Invalid or missing contributor, extension, or instance IDs leading to "not found" errors.
    • Authentication failures due to incorrect or expired API credentials.
    • Webhook failures if the allowWebhookFailure flag is set to false and the webhook endpoint is unreachable.

  • Error messages:

    • Unauthorized or forbidden errors indicate problems with API key permissions.
    • Validation errors may occur if required properties are missing or malformed.
    • Network or timeout errors when connecting to the mittwald API.

  • Resolutions:

    • Verify all IDs are correct and correspond to existing entities.
    • Ensure the API key credential is valid and has necessary permissions.
    • Check network connectivity and webhook endpoint availability.
    • Adjust the Allow Webhook Failure property based on tolerance for webhook errors.

Links and References

Discussion