GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows banning a user in GitLab by sending a POST request to the GitLab API endpoint `/api/v4/users/{id}/ban`. It is useful for administrators who need to restrict access for specific users by their user ID. For example, an admin can automate banning users who violate policies by specifying their user ID.

Use Case Examples

  1. Ban a user with ID 123 by sending a POST request to `/api/v4/users/123/ban`.
  2. Automate user management by integrating this node to ban users based on certain triggers or conditions.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET but POST is used for banning users.
Path Parameters Parameters to be included in the request path, specifically the user ID to ban.

Output

JSON

  • id - The ID of the banned user.
  • message - Response message from the API indicating the result of the ban operation.

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 credentials are correctly configured and have sufficient permissions to ban users.
  • Check the base URL to ensure it points to the correct GitLab instance.
  • Common error messages may include 404 Not Found if the user ID does not exist, or 403 Forbidden if the credentials lack permission to ban users.

Links

Discussion