GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves the list of groups shared with a specified GitLab group by its ID. It is useful for scenarios where you need to manage or analyze group sharing relationships within GitLab, such as auditing shared access or integrating group data into workflows.

Use Case Examples

  1. Get all groups shared with a specific GitLab group by providing the group ID.
  2. Filter shared groups by visibility or minimum access level to refine the results.
  3. Paginate through shared groups with page and per_page parameters for large datasets.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication The authentication method used for the request, hidden unless Skip Authentication is false.
baseUrl The base URL of the GitLab instance to send the request to.
Method HTTP method to use for the request (GET, POST, PUT, DELETE, HEAD, PATCH).
Parameter Schema Defines the parameters accepted by the API endpoint, including path and query parameters such as group ID, skip_groups, visibility, search, min_access_level, order_by, sort, page, per_page, and with_custom_attributes.
Query Parameters Collection of optional query parameters to filter and control the response, including skip_groups, visibility, search, min_access_level, order_by, sort, page, per_page, and with_custom_attributes.
Path Parameters Collection of path parameters required for the request, specifically the group ID (id).

Output

JSON

  • id - The ID of the shared group.
  • name - The name of the shared group.
  • path - The path of the shared group.
  • visibility - The visibility level of the shared group (private, internal, public).
  • access_level - The access level the authenticated user has to the shared group.
  • custom_attributes - Custom attributes included if requested in the response.

Dependencies

  • GitLab API authentication

Troubleshooting

  • Ensure the group ID provided in the path parameters is valid and exists in GitLab.
  • Verify that the authentication credentials are correctly configured unless Skip Authentication is enabled.
  • Check that query parameters are correctly formatted, especially arrays like skip_groups.
  • Common error messages may include 404 Not Found if the group ID does not exist, or 401 Unauthorized if authentication fails.

Links

Discussion