GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation unbans a user in GitLab by sending a POST request to the GitLab API endpoint `/api/v4/users/{id}/unban`. It is useful for administrators who want to lift a ban on a specific user by specifying the user's ID. For example, if a user was previously banned due to policy violations, this operation can be used to restore their access.

Use Case Examples

  1. Unban a user with ID 123 by setting the path parameter `id` to 123 and executing the operation.
  2. Use this operation in an automation workflow to manage user access dynamically based on external triggers.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). If true, authentication is skipped.
Authentication The authentication method used for the request, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method used for the request, defaulting to POST for this operation.
Parameter Schema Defines the path parameter `id` which is the ID of the user to unban (integer, required).
Request Body Schema Schema for the request body, which is null for this operation (no body required).
Request Path The API endpoint path `/api/v4/users/{id}/unban` used for this operation.
Path Parameters Collection of path parameters, specifically the `id` of the user to unban (string).

Output

JSON

  • id - The ID of the unbanned user.
  • username - The username of the unbanned user.
  • name - The full name of the unbanned user.
  • state - The state of the user after unbanning, typically 'active'.
  • created_at - Timestamp when the user was created.
  • updated_at - Timestamp when the user was last updated.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the user ID provided in the path parameter is valid and exists in the GitLab instance.
  • Authentication errors may occur if the API key credential is missing or invalid; verify the credential configuration.
  • The operation requires the user to have sufficient permissions to unban users; lack of permissions will result in authorization errors.
  • Network connectivity issues to the GitLab instance can cause request failures; verify the base URL and network access.

Links

Discussion