mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node operation "Project List Memberships For Project" retrieves a list of memberships associated with a specific project. It is useful for scenarios where you need to manage or audit user access and roles within a project, such as checking who has access, their roles, and membership status details. Practical examples include generating reports on project collaborators, verifying permissions before performing sensitive actions, or automating notifications to project members.

Properties

Name Meaning
Project Id The unique identifier of the project for which to list memberships.
Limit Maximum number of membership records to return in the response (pagination control).
Skip Number of membership records to skip before starting to collect the result set (pagination offset).
Has Expiry Filter memberships by whether they have an expiry date (true or false).
Is Inherited Filter memberships by whether they are inherited from a parent entity (true or false).
Role Filter memberships by role type. Options: Notset, Owner, Emailadmin, External.
Has Mfa Filter memberships by whether the member has multi-factor authentication enabled (true or false).

Output

The output JSON contains a list of membership objects related to the specified project. Each membership object typically includes details such as the member's identity, role, expiry status, inheritance status, and MFA status. This structured data allows further processing or integration into workflows that require knowledge of project membership composition.

If the node supports binary data output, it would represent any associated files or attachments related to memberships, but this operation primarily returns JSON data about memberships.

Dependencies

  • Requires an API key credential for authenticating requests to the mittwald mStudio API.
  • The node uses the base URL https://api.mittwald.de to send requests.
  • No additional external dependencies beyond the configured API credential and network access to the mittwald API.

Troubleshooting

  • Common Issues:

    • Invalid or missing Project Id will cause the API request to fail or return no results.
    • Incorrect API credentials or expired tokens will lead to authentication errors.
    • Network connectivity issues can prevent successful API calls.
    • Using incompatible filter values (e.g., unsupported role names) may result in empty responses.

  • Error Messages:

    • Authentication errors usually indicate invalid API keys; verify and update credentials.
    • "Not Found" errors suggest the Project Id does not exist or is inaccessible.
    • Rate limiting or quota exceeded errors require waiting or adjusting usage patterns.

Links and References

Discussion