GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves invitations for a specific group from the GitLab API (version 4). It is useful for scenarios where you need to manage or review pending invitations to a GitLab group, such as automating group membership management or auditing invitations. For example, you can fetch all invitations for a group to display them in a dashboard or to process them programmatically.

Use Case Examples

  1. Fetch all invitations for a GitLab group by specifying the group ID.
  2. Paginate through invitations using page and per_page query parameters.
  3. Search invitations by a query string to find specific members.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request.
Authentication The authentication method used for the request, defaulting to GitLab API key.
baseUrl The base URL of the GitLab instance to which the request is sent.
Method The HTTP method used for the request, defaulting to GET.
Parameter Schema Defines the parameters for the API call including path and query parameters such as group ID, page number, items per page, and search query.
Request Body Schema Schema for the request body, which is null for this GET operation.
Request Path The API endpoint path with a placeholder for the group ID.
Query Parameters Collection of optional query parameters to control pagination and search filtering.
Path Parameters Collection of path parameters including the group ID to specify the target group.

Output

JSON

  • invitations - List of invitations retrieved from the GitLab group.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the group ID is valid and accessible with the provided API credentials.
  • Check that the API base URL is correct and reachable.
  • Verify that the API key has sufficient permissions to read group invitations.
  • Common errors include authentication failures, invalid group ID, or network connectivity issues. Resolving these typically involves verifying credentials, input parameters, and network settings.

Links

Discussion