GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves the list of groups shared with a specified GitLab group by making an API call to the GitLab endpoint `/api/v4/groups/{id}/groups/shared`. It is useful for scenarios where you need to manage or analyze group sharing relationships within GitLab, such as auditing shared group access or integrating group data into workflows.

Use Case Examples

  1. Retrieve 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 to handle large datasets.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the API request.
Authentication The authentication method used for the API request, hidden unless Skip Authentication is false.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method HTTP method used for the API 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.
Request Body Schema Schema for the request body, if applicable (null for this GET operation).
Request Path The API endpoint path template `/api/v4/groups/{id}/groups/shared` used for the request.
Query Parameters Collection of optional query parameters to filter and paginate the shared groups list, 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.
  • shared_since - Timestamp indicating when the group was shared.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the provided group ID (`id`) is valid and exists in GitLab to avoid 404 errors.
  • Verify that the authentication credentials are correct and have sufficient permissions to access group sharing information.
  • Check that query parameters are correctly formatted, especially arrays like `skip_groups` which should be comma-separated if passed as strings.
  • If the API returns rate limit errors, consider adding delays or retries in your workflow.

Links

Discussion