GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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, when managing user lifecycle or cleaning up inactive accounts. The operation supports specifying the user ID to delete and optionally whether to perform a hard delete that removes the user's contributions.

Use Case Examples

  1. Deleting a user by their ID to revoke access and remove their account from GitLab.
  2. Performing a hard delete to remove a 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, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to send the request to, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, default is GET but DELETE is used for this operation.
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 or status from the delete operation

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the user ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the API key used for authentication has sufficient permissions to delete users.
  • Check the baseUrl is correctly set to the GitLab instance URL if using a self-hosted GitLab.
  • If 'hard_delete' is used, confirm that the API supports this parameter and it is correctly formatted as a boolean or string as required.
  • Common error messages include '404 Not Found' if the user ID does not exist, and '403 Forbidden' if the API key lacks permissions.

Links

Discussion