GitLab API icon

GitLab API

Gitlab

Actions917

Overview

This node interacts with the GitLab API to retrieve user preferences via the API v4 endpoint. It is useful for workflows that need to access or utilize a user's GitLab preferences programmatically, such as customizing user experience or integrating GitLab user settings into other systems.

Use Case Examples

  1. Retrieve the current user's GitLab preferences to adjust application behavior based on those settings.
  2. Automate the extraction of user preferences for reporting or synchronization with other tools.

Properties

Name Meaning
Skip Authentication Determines whether to bypass authentication for the request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to connect to, defaulting to https://gitlab.com.
Method HTTP method to use for the request, defaulting to GET.
Parameter Schema Hidden property for the parameter schema of the getApiV4UserPreferences operation.
Request Body Schema Hidden property for the request body schema of the getApiV4UserPreferences operation.
Request Path Hidden property specifying the API path for the getApiV4UserPreferences operation, set to /api/v4/user/preferences.

Output

JSON

  • preferences - The JSON object containing the user's GitLab preferences retrieved from the API.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to access user preferences.
  • Verify the baseUrl is correct and accessible, especially if using a self-hosted GitLab instance.
  • If skipping authentication, the request may fail due to lack of authorization.

Links

Discussion