GitLab API icon

GitLab API

Gitlab

Actions880

Overview

This node operation interacts with the GitLab API to retrieve groups associated with a specific project identified by its ID or URL-encoded path. It supports filtering and pagination options to customize the list of groups returned. This is useful for scenarios where you need to manage or analyze group memberships related to a project in GitLab, such as automating access control or auditing group associations.

Use Case Examples

  1. Retrieve all groups linked to a project by its ID.
  2. Filter groups by search criteria or exclude certain group IDs.
  3. Paginate through groups with specified page number and items per page.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, hidden unless Skip Authentication is false.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Query Parameters Collection of optional query parameters to filter and paginate the groups list.
Path Parameters Path parameter specifying the project ID or URL-encoded path.

Output

JSON

  • id - The ID of the group associated with the project.
  • name - The name of the group.
  • path - The URL path of the group.
  • description - Description of the group.
  • visibility - Visibility level of the group.
  • lfs_enabled - Indicates if Large File Storage is enabled for the group.
  • avatar_url - URL of the group's avatar image.
  • web_url - Web URL to access the group in GitLab.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the project ID or path is correctly specified in the path parameters to avoid 404 errors.
  • Verify that the authentication token has sufficient permissions to access project groups.
  • Check query parameter formats, especially for arrays and boolean values, to prevent request errors.
  • If pagination parameters are used, ensure they are within valid ranges to avoid empty responses or errors.

Links

Discussion