GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

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 Defines the schema for the parameters sent in the request body for updating user preferences.
Request Body Schema Schema for the request body, defining the structure of user preferences to update.
Request Path The API endpoint path for updating user preferences, fixed to /api/v4/user/preferences.

Output

JSON

  • response - The JSON response from the GitLab API after updating user preferences, containing the updated preferences data.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has sufficient permissions to update user preferences.
  • Verify the baseUrl is correct and accessible, especially if using a self-hosted GitLab instance.
  • Check that the request body matches the expected schema for user preferences to avoid validation errors from the API.

Links

Discussion