GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation updates a user in GitLab by sending a PUT request to the GitLab API endpoint `/api/v4/users/{id}`. It is useful for modifying user details such as name, email, or other user attributes in a GitLab instance. Typical use cases include automating user management tasks in GitLab, such as updating user profiles or permissions programmatically.

Use Case Examples

  1. Updating a user's email address in GitLab.
  2. Changing a user's username or other profile details via an automated workflow.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using authentication for the request.
Authentication The authentication method used for the request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the request, defaulting to GET but set to PUT for this operation.
Path Parameters The path parameters for the request, specifically the user ID to identify which user to update.

Output

JSON

  • id - The unique identifier of the updated user.
  • username - The username of the updated user.
  • email - The email address of the updated user.
  • name - The full name of the updated user.
  • state - The state of the user (e.g., active, blocked).
  • avatar_url - URL to the user's avatar image.
  • web_url - URL to the user's GitLab profile page.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the user ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the authentication credentials are correct and have sufficient permissions to update user details.
  • Check that the base URL is correctly set to the GitLab instance URL if using a self-hosted GitLab.
  • Common error messages include 401 Unauthorized (authentication failure), 404 Not Found (user ID does not exist), and 400 Bad Request (invalid request body). Resolving these involves correcting credentials, user ID, or request payload respectively.

Links

Discussion