GitLab API

GitlabTool

Actions1000

Overview

This node operation retrieves the groups invited to a specific GitLab project using the GitLab API. It is useful for scenarios where you need to manage or audit group access to a project, such as checking which groups have been granted permissions or filtering groups by relation or access level. For example, a user can fetch all groups invited to a project to review their access or search for a specific group among the invited ones.

Use Case Examples

  1. Fetch all invited groups for a project by providing the project ID.
  2. Filter invited groups by their relation type (direct or inherited) to the project.
  3. Search for a specific group among the invited groups using a search term.
  4. Limit the results by minimum access level of the authenticated user to see only groups with certain permissions.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to connect to, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Parameter Schema Defines the parameters accepted by the API endpoint, including path and query parameters such as project ID, relation filter, search term, minimum access level, pagination, and custom attributes inclusion.
Request Body Schema Schema for the request body, not used in this GET operation (null).
Request Path The API endpoint path template for retrieving invited groups of a project: /api/v4/projects/{id}/invited_groups.
Query Parameters Collection of optional query parameters to filter and paginate the invited groups list, including relation, search, min_access_level, page, per_page, and with_custom_attributes.
Path Parameters Collection of path parameters including the project ID or URL-encoded path to identify the project.

Output

JSON

  • id - The unique identifier of the invited group.
  • name - The name of the invited group.
  • path - The URL path of the invited group.
  • description - Description of the invited 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 - Web URL to access the group in 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 this group is nested.
  • shared_with_groups - Groups that this group is shared with.
  • permissions - Permissions the authenticated user has on the group.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible by the authenticated user.
  • Verify that the authentication credentials (GitLab API key) are valid and have sufficient permissions to access project group information.
  • Check the baseUrl if connecting to a self-hosted GitLab instance to ensure it is correct.
  • If filtering by relation or access level, confirm the values are valid as per the API documentation.
  • Pagination parameters (page, per_page) should be positive integers; invalid values may cause errors.

Links

Discussion