GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation allows updating user preferences on GitLab via the API endpoint `/api/v4/user/preferences`. It is useful for automating the customization of user settings programmatically, such as changing notification preferences or interface options. For example, a user can automate setting their GitLab preferences after account creation or as part of a workflow to standardize user environments.

Use Case Examples

  1. Automate updating GitLab user preferences after onboarding.
  2. Change notification settings for a user via an automated workflow.

Properties

Name Meaning
Skip Authentication Determines whether to skip API 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 API request is sent.
Method HTTP method to use for the request, default is GET but for this operation it should be PUT.
Parameter Schema Defines the schema for the request body parameters for updating user preferences.
Request Body Schema Schema for the request body content, 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 preference data.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the GitLab API key credential is valid and has sufficient permissions to update user preferences.
  • Verify the baseUrl is correct and accessible.
  • Check that the request body matches the expected schema for user preferences to avoid validation errors.
  • Common error messages include authentication failures (401 Unauthorized) and validation errors (400 Bad Request) if the request body is malformed.

Links

Discussion