GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node interacts with the GitLab API to deactivate a user by their user ID. It is useful in scenarios where an administrator needs to disable a user's access to a GitLab instance, for example, when an employee leaves an organization or when access needs to be temporarily revoked. The node sends a POST request to the GitLab API endpoint `/api/v4/users/{id}/deactivate` to perform the deactivation.

Use Case Examples

  1. Deactivating a user by specifying their user ID to prevent them from accessing the GitLab instance.
  2. Automating user management workflows by integrating this node to deactivate users based on certain triggers or conditions.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for testing or when authentication is handled externally.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method HTTP method used for the request, defaulting to POST for this operation.
Parameter Schema Defines the path parameter 'id' which is the user ID to deactivate.
Request Body Schema Schema for the request body, not used in this operation (null).
Request Path The API endpoint path template for deactivating a user, with a placeholder for user ID.
Path Parameters Collection of path parameters, specifically the 'id' parameter representing the user ID to deactivate.

Output

JSON

  • response - The JSON response from the GitLab API after attempting to deactivate the user, typically including status or confirmation details.

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.
  • Verify that the API key credential has sufficient permissions to deactivate users.
  • Check the base URL to confirm it points to the correct GitLab instance.
  • If skipping authentication, ensure the API endpoint allows unauthenticated requests, otherwise the request will fail.

Links

Discussion