GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation deletes a user from GitLab using the GitLab API. It is useful for administrators who need to remove user accounts programmatically. For example, it can be used in automated workflows to clean up user accounts that are no longer needed or to enforce user management policies.

Use Case Examples

  1. Deleting a user by their ID to revoke access and remove their account from the GitLab instance.
  2. Optionally performing a hard delete to remove the user's contributions along with their account.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used for the request, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance to which the request is sent. Defaults to https://gitlab.com.
Method The HTTP method used for the request. For this operation, DELETE is typically used.
Query Parameters Optional query parameters for the request, including 'hard_delete' to specify whether to remove the user's contributions.
Path Parameters Path parameters for the request, including the 'id' of the user to delete.

Output

JSON

  • id - The ID of the deleted user.
  • message - Response message confirming the deletion or providing error details.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the user ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the API authentication token has sufficient permissions to delete users.
  • If 'hard_delete' is used, confirm that the API supports this parameter and that the user has the necessary rights to remove contributions.
  • Check the baseUrl to ensure it points to the correct GitLab instance.

Links

Discussion