GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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 project manager might use this to list all groups invited to a project to review access rights.

Use Case Examples

  1. Retrieve all groups invited to a project by specifying the project ID.
  2. Filter invited groups by their relation to the project (direct or inherited).
  3. Search for a specific group among the invited groups.
  4. Limit results by minimum access level of the authenticated user.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated access scenarios.
Authentication Type of authentication used, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Query Parameters Optional query parameters to filter and paginate the invited groups list.
Path Parameters Path parameters required for the request, specifically the project ID or URL-encoded path.

Output

JSON

  • id - The unique identifier of the invited group.
  • name - The name of the invited group.
  • path - The path of the invited group.
  • description - Description of the invited group.
  • visibility - Visibility level of the invited group.
  • access_level - Access level granted to the group for the project.
  • group_id - The ID of the group invited to the project.
  • project_id - The ID of the project to which the group is invited.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the authenticated user.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access project group invitations.
  • Check that query parameters are correctly formatted, especially for enum values like relation and min_access_level.
  • If skipping authentication, ensure the GitLab instance allows unauthenticated access to the requested resource.

Links

Discussion