GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation deletes a custom attribute for a specific user in GitLab via the GitLab API. It is useful for managing user metadata by removing custom attributes that are no longer needed or relevant. For example, an admin can use this operation to clean up user profiles by deleting outdated or incorrect custom attributes.

Use Case Examples

  1. Deleting a custom attribute 'department' for user with ID 123 to update user metadata.
  2. Removing a custom attribute 'projectRole' from a user profile to reflect changes in project assignments.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
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.
Method The HTTP method used for the API request, which is DELETE for this operation.
Parameter Schema Defines the required path parameters 'id' (user ID) and 'key' (custom attribute key) for the API endpoint.
Request Body Schema No request body is required for this DELETE operation.
Request Path The API endpoint path template for deleting a user's custom attribute, including placeholders for 'id' and 'key'.
Path Parameters Collection of path parameters including 'id' (user ID) and 'key' (custom attribute key) to specify which custom attribute to delete.

Output

JSON

  • success - Indicates whether the custom attribute was successfully deleted (typically a boolean or status message).
  • statusCode - HTTP status code returned by the API indicating the result of the delete operation.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the user ID and custom attribute key are correct and exist in GitLab to avoid 404 Not Found errors.
  • Verify that the API key used has sufficient permissions to delete user custom attributes to prevent authorization errors (e.g., 403 Forbidden).
  • Check the base URL is correctly set to the GitLab instance URL to avoid connection errors.

Links

Discussion