mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node operation, "Project List Project Memberships," interacts with the mittwald mStudio API to retrieve a list of project memberships. It is useful for scenarios where you need to manage or audit user roles and memberships within projects hosted on the mittwald platform. For example, a user might want to fetch all members of a specific project along with their roles and membership details to synchronize access controls or generate reports.

Properties

Name Meaning
Limit The maximum number of project memberships to return in the response.
Skip The number of project memberships to skip before starting to collect the result set.
Has Expiry Filter memberships by whether they have an expiry date (true or false).
Is Inherited Filter memberships by whether they are inherited (true or false).
Role Filter memberships by role. Options: Notset, Owner, Emailadmin, External.

Output

The output contains a JSON array of project membership objects as returned by the mittwald mStudio API. Each object typically includes details about the member, their role, expiry status, and inheritance status within the project. The exact structure depends on the API response but generally provides comprehensive membership information.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authentication with the mittwald mStudio API.
  • The base URL for API requests is https://api.mittwald.de.
  • The node uses standard HTTP headers for JSON content negotiation (Accept: application/json and Content-Type: application/json).

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing invalid filter values (e.g., unsupported role names) may result in empty responses or errors.
    • Network connectivity issues can prevent successful API calls.

  • Error messages:

    • Authentication errors typically indicate problems with the provided API key; verify that the key is correct and has necessary permissions.
    • Validation errors may occur if query parameters like limit or skip are out of acceptable ranges; ensure these are non-negative integers.
    • API rate limiting errors suggest too many requests in a short time; implement retry logic or reduce request frequency.

Links and References

Discussion