GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation allows sending invitations to a GitLab group by making a POST request to the GitLab API endpoint `/api/v4/groups/{id}/invitations`. It is useful for automating the process of inviting users to a specific group in GitLab, such as when managing team memberships or onboarding new collaborators.

Use Case Examples

  1. Automatically invite new team members to a GitLab group when they are added to a project management tool.
  2. Send batch invitations to a GitLab group as part of a user provisioning workflow.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for testing or public endpoints.
Authentication Select the authentication method to use, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is POST for this operation.
Path Parameters Parameters to be included in the request path, specifically the group ID to which the invitation is sent.

Output

JSON

  • id - The unique identifier of the invitation created.
  • email - The email address of the invited user.
  • access_level - The access level granted to the invited user in the group.
  • created_at - Timestamp when the invitation was created.
  • invited_by - Information about the user who sent the invitation.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the group ID provided in the path parameters is correct and the authenticated user has permission to invite members to the group.
  • Check that the API key credential is valid and has sufficient scopes to perform group invitations.
  • If skipping authentication, verify that the GitLab instance allows unauthenticated requests for this endpoint, which is uncommon.
  • Common error messages include 401 Unauthorized (invalid or missing API key), 403 Forbidden (insufficient permissions), and 404 Not Found (invalid group ID). Resolving these involves verifying credentials, permissions, and input parameters.

Links

Discussion