GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation retrieves the list of invited groups for a specified GitLab group by its ID. It is useful for scenarios where you need to manage or audit group invitations within GitLab, such as checking which groups have been invited to collaborate on a project or group. For example, a user can fetch invited groups to verify access permissions or to automate group management tasks.

Use Case Examples

  1. Fetch invited groups for a GitLab group to audit access.
  2. Retrieve invited groups to automate group membership management.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
method HTTP method to use for the request, default is GET.
queryParameters.relation Include group relations, can be 'direct' or 'inherited'.
queryParameters.search Search for a specific group by name or criteria.
queryParameters.min_access_level Minimum access level of the authenticated user to filter results.
queryParameters.page Current page number for paginated results.
queryParameters.per_page Number of items per page for pagination.
queryParameters.with_custom_attributes Include custom attributes in the response if true.
pathParameters.id The ID of the GitLab group to retrieve invited groups for.

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.
  • lfs_enabled - Indicates if Large File Storage is enabled for the group.
  • avatar_url - URL to the group's avatar image.
  • web_url - Web URL of the invited group.
  • request_access_enabled - Indicates if access requests are enabled for the group.
  • full_name - Full name of the invited group.
  • full_path - Full path of the invited group.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the group ID provided in path parameters is valid and exists in GitLab.
  • Verify that the authentication token has sufficient permissions to access group invitation data.
  • Check the base URL if using a self-hosted GitLab instance to ensure it is correct.
  • If pagination parameters are used, ensure they are within valid ranges to avoid empty responses or errors.

Links

Discussion