GitLab API

GitlabTool

Actions905

Overview

This node operation retrieves groups associated with a specific GitLab project using the GitLab API v4. It is useful for scenarios where you need to list or filter groups linked to a project, such as managing project permissions or auditing group memberships. For example, you can fetch all groups sharing access to a project or filter groups by search criteria or access levels.

Use Case Examples

  1. Fetch all groups linked to a project by its ID.
  2. Search for groups matching a specific name related to a project.
  3. Exclude certain groups from the results by their IDs.
  4. Limit the results to shared groups with a minimum access level.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request.
Authentication The authentication method used, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Parameter Schema Defines the parameters for the API call including project ID, search criteria, pagination, and filtering options.
Query Parameters Collection of optional query parameters to filter and paginate the groups list, such as search term, excluded groups, shared groups inclusion, access levels, and pagination controls.
Path Parameters Path parameter specifying the project ID or URL-encoded path to identify the project.

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 (e.g., private, internal, public).
  • share_with_group_lock - Indicates if sharing with groups is locked.
  • require_two_factor_authentication - Indicates if two-factor authentication is required for the group.
  • two_factor_grace_period - Grace period for two-factor authentication enforcement.
  • project_creation_level - Level of project creation permissions within the group.
  • subgroup_creation_level - Level of subgroup creation permissions within the group.
  • emails_disabled - Indicates if emails are disabled for the group.
  • mentions_disabled - Indicates if mentions are disabled for the group.
  • lfs_enabled - Indicates if Large File Storage (LFS) is enabled for the group.
  • avatar_url - URL to the group's avatar image.
  • web_url - Web URL to access the group in GitLab.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the authenticated user.
  • Verify that the API token or authentication credentials have sufficient permissions to access project groups.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • If filtering by access level or shared groups, confirm the values conform to the allowed enums and boolean types.
  • Pagination parameters should be valid integers; otherwise, the API may return errors or unexpected results.

Links

Discussion