GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to update user preferences via a PUT request to the /api/v4/user/preferences endpoint. It is useful for automating the customization of user settings in GitLab, such as adjusting notification preferences or interface options programmatically.

Use Case Examples

  1. Automatically update user preferences after onboarding a new team member.
  2. Synchronize user settings across multiple GitLab accounts or projects.

Properties

Name Meaning
Skip Authentication Determines whether to skip 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 which the request is sent.
Method HTTP method to use for the request, default is GET but for this operation it is PUT.
Parameter Schema Schema defining the parameters for the putApiV4UserPreferences operation.
Request Body Schema Schema defining the structure of the request body for the putApiV4UserPreferences operation.
Request Path The API endpoint path for updating user preferences.

Output

JSON

  • response - The JSON response from the GitLab API after updating user preferences.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the GitLab API key credential is valid and has sufficient permissions to update user preferences.
  • Verify the baseUrl is correct and accessible from the network where the node runs.
  • Check that the request body matches the expected schema for user preferences to avoid validation errors.

Links

Discussion