GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation deletes a user from GitLab using the GitLab API. It is useful for automating user management tasks such as removing users who no longer need access to a GitLab instance. For example, an admin can use this node to delete a user by specifying their user ID, optionally choosing to hard delete the user's contributions as well.

Use Case Examples

  1. Deleting a user by their ID to revoke access.
  2. Hard deleting a user to remove their contributions from the GitLab instance.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used for the API request, 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 DELETE for this operation.
Query Parameters Optional query parameters for the API request, including 'hard_delete' to specify whether to remove the user's contributions.
Path Parameters Path parameters for the API request, specifically the 'id' of the user to delete.

Output

JSON

  • id - The ID of the deleted user
  • message - Response message from the API, e.g., confirmation of deletion or error message

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.
  • If authentication is skipped, the API request may fail due to lack of permissions.
  • Check that the baseUrl is correctly set to the GitLab instance URL.
  • If 'hard_delete' is set, ensure the user has permissions to perform this action, as it removes user contributions permanently.

Links

Discussion