GitLab API

GitlabTool
Join our community

Actions1000

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 associated with a project that match a specific name.
  3. Exclude certain groups from the results when listing project groups.

Properties

Name Meaning
Skip Authentication Option to bypass authentication for the request.
Authentication Type of authentication used for the API request, hidden unless Skip Authentication is false.
baseUrl Base URL of the GitLab instance to send the request to.
Method HTTP method to use for the API request.
Parameter Schema Defines the parameters accepted by the API endpoint, including path and query parameters such as project ID, search term, pagination, and access level filters.
Query Parameters Collection of optional query parameters to filter or paginate the groups list, including search, skip_groups, with_shared, shared_visible_only, shared_min_access_level, page, and per_page.
Path Parameters Collection of path parameters required by the API endpoint, specifically the project ID.

Output

JSON

  • id - The ID of the group.
  • 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 to the group's avatar image.
  • web_url - URL to the group's web page.
  • request_access_enabled - Indicates if access requests are enabled for the group.
  • full_name - Full name of the group.
  • full_path - Full path of the group.

Dependencies

  • An API key credential for GitLab authentication

Troubleshooting

  • Ensure the project ID path parameter is correctly set and URL-encoded if necessary.
  • Verify that the API key credential is valid and has sufficient permissions to access project groups.
  • Check that the base URL is correct for the GitLab instance being accessed.
  • If using query parameters like skip_groups or shared_min_access_level, ensure they are formatted correctly according to the API specification.

Links

Discussion