GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves detailed information about a specific group from the GitLab API (version 4). It is useful for scenarios where you need to fetch group details such as membership, attributes, and associated projects within GitLab. For example, it can be used in automation workflows to monitor group settings or integrate group data into other systems.

Use Case Examples

  1. Fetch details of a GitLab group by its ID to display in a dashboard.
  2. Automate the retrieval of group information for auditing or reporting purposes.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, defaulting to GET.
Query Parameters Optional query parameters to customize the API request, including 'with_custom_attributes' to include custom attributes in the response and 'with_projects' to omit project details.
Path Parameters Path parameters for the API request, specifically the 'id' of the group to retrieve.

Output

JSON

  • id - The unique identifier of the group.
  • name - The name of the group.
  • path - The path of the group within GitLab.
  • description - Description of the group.
  • visibility - Visibility level of the group (e.g., private, internal, public).
  • lfs_enabled - Indicates if Large File Storage (LFS) is enabled for the group.
  • avatar_url - URL to the group's avatar image.
  • web_url - URL to the group's web page on GitLab.
  • request_access_enabled - Indicates if users can request access to the group.
  • full_name - Full name of the group.
  • full_path - Full path of the group.
  • parent_id - ID of the parent group, if any.
  • projects - List of projects under the group, included if 'with_projects' is true.
  • custom_attributes - Custom attributes of the group, included if 'with_custom_attributes' is true.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the 'id' path parameter is provided and valid; missing or incorrect IDs will cause errors.
  • Verify that the base URL is correct and accessible, especially if using a self-hosted GitLab instance.
  • Authentication errors may occur if the API key is missing, invalid, or lacks necessary permissions.
  • Check query parameters for correct boolean values; improper values may lead to unexpected API responses.

Links

Discussion