GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation allows users to add a user cluster to a specific GitLab group by making a POST request to the GitLab API endpoint `/api/v4/groups/{id}/clusters/user`. It is useful for managing Kubernetes clusters associated with GitLab groups, enabling automation of cluster user assignments within group contexts.

Use Case Examples

  1. Automatically add a Kubernetes cluster user to a GitLab group when a new project is created.
  2. Manage group cluster users programmatically to maintain consistent access control across multiple GitLab groups.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip using 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, defaulting to https://gitlab.com.
Method The HTTP method used for the API request, defaulting to POST for this operation.
Path Parameters Parameters included in the request path, specifically the group ID to which the cluster user will be added.

Output

JSON

  • response - The JSON response from the GitLab API after adding the cluster user to the group, typically including details of the cluster user or confirmation of the operation.

Dependencies

  • Requires GitLab API key authentication unless skipping authentication is enabled.

Troubleshooting

  • Ensure the group ID path parameter is correctly provided and valid; missing or incorrect IDs will cause request failures.
  • Authentication errors may occur if the GitLab API key is missing, invalid, or lacks sufficient permissions to add cluster users to groups.
  • API rate limits or network issues may cause request failures; verify connectivity and API usage limits.

Links

Discussion