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 Get Group operation, it retrieves detailed information about a specified security group within the Dataiku DSS instance.

Common scenarios where this node is beneficial include:

  • Automating security audits by fetching group details programmatically.
  • Integrating group information retrieval into larger workflows for user management or compliance checks.
  • Dynamically accessing group configurations to adjust permissions or monitor access.

For example, a user might use this node to get the details of a particular security group by specifying its name, then use that data to verify group membership or synchronize group settings with another system.

Properties

Name Meaning
Group Name The name of the security group to retrieve information about. This is required for operations like getting, updating, or deleting a group.

(Note: The provided properties JSON shows "Group Name" as an input property relevant for operations including securityGroupsGet.)

Output

The output of the node is a JSON object representing the response from the Dataiku DSS API for the requested operation.

For the Get Group operation under the Security resource, the output JSON will contain the details of the specified security group. This typically includes attributes such as group members, permissions, and other metadata related to the group.

If the operation involves downloading files (not applicable for Get Group), the node can output binary data representing the downloaded content. However, for the Get Group operation, the output is purely JSON.

Example output structure (conceptual):

{
  "groupName": "example-group",
  "members": [
    "user1",
    "user2"
  ],
  "permissions": {
    "read": true,
    "write": false,
    ...
  },
  "description": "Description of the group"
}

Dependencies

  • Requires an active connection to a Dataiku DSS instance.
  • Requires valid API credentials (an API key credential) for authentication with the Dataiku DSS API.
  • The node expects the Dataiku DSS server URL and user API key to be configured in the credentials.
  • No additional external dependencies beyond the Dataiku DSS API and n8n's HTTP request capabilities.

Troubleshooting

  • Missing Credentials Error: If the node throws an error about missing API credentials, ensure that the Dataiku DSS API credentials are properly set up in n8n and linked to the node.
  • Required Parameter Missing: Errors indicating missing parameters such as "Group Name is required" mean you must provide the group name input property when using the Get Group operation.
  • API Request Failures: Network issues, incorrect server URLs, or invalid API keys can cause request failures. Verify connectivity and credentials.
  • Unexpected Response Format: If the API returns unexpected data or errors, check the Dataiku DSS API documentation for any changes or required permissions.

Links and References


This summary focuses on the Security resource's Get Group operation, describing how to use the node to fetch group details from Dataiku DSS securely and effectively.

Discussion