GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation allows users to retrieve groups from the GitLab API (version 4). It supports various query parameters to filter, sort, and paginate the list of groups, such as filtering by visibility, ownership, access level, and search terms. This operation is useful for scenarios where you need to programmatically access and manage GitLab groups, for example, to list all groups a user has access to, or to find specific groups based on criteria like visibility or name.

Use Case Examples

  1. Retrieve all public groups available to the authenticated user.
  2. Search for groups by name containing a specific keyword.
  3. List groups owned by the authenticated user, sorted by name in ascending order.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
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. Defaults to https://gitlab.com.
Method HTTP method to use for the request. Defaults to GET.
Query Parameters Collection of query parameters to filter and control the groups list. Includes options like statistics, skip_groups, all_available, visibility, search, owned, order_by, sort, min_access_level, top_level_only, repository_storage, marked_for_deletion_on, page, per_page, and with_custom_attributes.

Output

JSON

  • id - Unique identifier of the group
  • name - Name of the group
  • path - Path of the group
  • description - Description of the group
  • visibility - Visibility level of the group (private, internal, public)
  • lfs_enabled - Whether 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
  • request_access_enabled - Whether request access is enabled for the group
  • full_name - Full name of the group
  • full_path - Full path of the group
  • parent_id - ID of the parent group if it exists
  • projects - List of projects under the group
  • statistics - Project statistics if requested
  • custom_attributes - Custom attributes included if requested

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the GitLab API credentials are correctly configured and valid to avoid authentication errors.
  • Verify the base URL is correct and accessible to prevent connection issues.
  • Check that query parameters are correctly formatted and valid according to GitLab API documentation to avoid request errors.
  • If the response is empty or incomplete, verify the permissions of the authenticated user to access the requested groups.

Links

Discussion