GitLab API icon

GitLab API

Gitlab

Actions880

Overview

This node interacts with the GitLab API to retrieve the authenticated user's preferences via the endpoint `/api/v4/user/preferences`. It is useful for scenarios where you need to programmatically access or manage user-specific settings in GitLab, such as automation scripts or integrations that require user preference data.

Use Case Examples

  1. Automating retrieval of user preferences to customize workflows based on user settings.
  2. Integrating GitLab user preferences into a dashboard or reporting tool.

Properties

Name Meaning
Skip Authentication Determines whether to skip the authentication step when making the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, defaulting to GET.
Parameter Schema Hidden property for the parameter schema of the API request, specific to the operation.
Request Body Schema Hidden property for the request body schema of the API request, specific to the operation.
Request Path The API endpoint path for retrieving user preferences, fixed to `/api/v4/user/preferences`.

Output

JSON

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

Dependencies

  • GitLab API key credential

Troubleshooting

  • If authentication fails, ensure the GitLab API key credential is correctly configured and has the necessary permissions.
  • If the API endpoint `/api/v4/user/preferences` is unreachable, verify the base URL is correct and the GitLab instance is accessible.
  • HTTP method should be GET for this operation; using other methods may result in errors.

Links

Discussion