GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows sharing a GitLab group with another entity by making a POST request to the GitLab API endpoint `/api/v4/groups/{id}/share`. It is useful for automating group sharing tasks in GitLab, such as granting access to a group for collaboration or management purposes.

Use Case Examples

  1. Automatically share a GitLab group with a user or another group when a new project is created.
  2. Integrate group sharing into a CI/CD pipeline to manage permissions dynamically.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, defaulting to GitLab API key authentication.
baseUrl 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 this operation.
Path Parameters Parameters to be included in the request path, specifically the group ID to share.

Output

JSON

  • id - The ID of the group being shared.
  • shared_with_group_id - The ID of the group with which the group is shared.
  • group_access - The level of access granted to the shared group.
  • expires_at - The expiration date of the share, if any.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the group ID provided in the path parameters is valid and exists in GitLab.
  • Verify that the API key used for authentication has sufficient permissions to share groups.
  • Check the request body schema to ensure all required fields for sharing a group are included and correctly formatted.
  • If skipping authentication, ensure the GitLab instance allows unauthenticated requests for this operation, which is uncommon.

Links

Discussion