GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to retrieve user preferences via the endpoint `/api/v4/user/preferences`. It is useful for workflows that need to access or manipulate user-specific settings stored in GitLab, such as customizing user experience or automating configuration checks.

Use Case Examples

  1. A workflow that fetches the current user's GitLab preferences to adjust subsequent automation steps based on those settings.
  2. An automation that audits user preferences across multiple GitLab accounts for compliance or reporting purposes.

Properties

Name Meaning
Skip Authentication Determines whether to bypass authentication for 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 operation, not user-configurable.
Request Body Schema Hidden property for the request body schema of the operation, not user-configurable.
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 GitLab preferences retrieved from the API.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • If authentication fails, verify that the GitLab API key credential is correctly configured and has sufficient permissions.
  • If the API request returns an error, check the baseUrl to ensure it points to a valid GitLab instance.
  • Ensure the HTTP method is set to GET for this operation, as other methods may not be supported for retrieving user preferences.

Links

Discussion