Dataiku DSS icon

Dataiku DSS

Use the Dataiku DSS API

Actions364

Overview

This node integrates with the Dataiku DSS API, allowing users to perform a wide range of operations on various Dataiku DSS resources. Specifically for the Security resource and the List Users operation, it retrieves a list of user accounts from the Dataiku DSS instance.

Common scenarios where this node is beneficial include:

  • Automating user management workflows by fetching user lists.
  • Auditing or monitoring user activity within Dataiku DSS.
  • Integrating user data into broader automation pipelines or reporting tools.

For example, an organization might use this node to regularly extract all users and their statuses to sync with an external identity management system or to generate compliance reports.

Properties

Name Meaning
Query Parameters A collection of optional parameters to filter or modify the API request. Options include: Active (boolean), All Users (boolean), Limit (number, max results), Page (number), and many others that can refine the query.

The "Query Parameters" property supports many options, such as filtering by active status, connected status, pagination controls (limit, page), and other specific filters relevant to different operations. For the List Users operation under the Security resource, these parameters can be used to customize which users are returned and how many.

Output

The node outputs JSON data representing the response from the Dataiku DSS API for the requested operation.

For the List Users operation, the output JSON will contain an array of user objects, each describing a user in the DSS instance. Typical fields may include user identifiers, login names, status flags, and other metadata about the users.

If the operation involves downloading files or binary content (not applicable for List Users), the node would output binary data accordingly.

Dependencies

  • Requires an API key credential for authenticating with the Dataiku DSS API.
  • The node expects the URL of the Dataiku DSS server and a valid user API key.
  • No additional external services are required beyond access to the Dataiku DSS instance.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing credentials, ensure that a valid API key credential for Dataiku DSS is configured in n8n.
  • Required Parameter Errors: Many operations require specific parameters (e.g., project key, user login). For the List Users operation, ensure any required query parameters are correctly set if needed.
  • API Endpoint Errors: If the API endpoint URL is incorrect or the server is unreachable, verify the Dataiku DSS server URL and network connectivity.
  • Permission Issues: The API key must have sufficient permissions to list users; otherwise, the API may return authorization errors.
  • Response Parsing Errors: If the API returns unexpected data, the node may fail to parse JSON. Check the API response format and ensure compatibility.

Links and References


This summary focuses on the Security resource and the List Users operation, extracting relevant input properties and describing the node's behavior based on static analysis of the provided source code and property definitions.

Discussion