GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation allows users to send invitations to a GitLab project by making a POST request to the GitLab API endpoint `/api/v4/projects/{id}/invitations`. It is useful for automating the process of inviting users to collaborate on a specific project within GitLab. For example, a project manager can use this node to programmatically invite team members to a project without manually sending invitations through the GitLab web interface.

Use Case Examples

  1. Automatically invite new team members to a GitLab project when they are added to a company directory.
  2. Send invitations to external collaborators to join a GitLab project as part of an onboarding workflow.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for testing or public endpoints.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
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 specify the project ID in the request path.

Output

JSON

  • id - The ID of the invitation created.
  • email - The email address of the invited user.
  • access_level - The access level granted to the invited user.
  • 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 project ID provided in the path parameters is correct and the project exists.
  • Verify that the API key used for authentication has sufficient permissions to invite users to the project.
  • Check the email format in the invitation payload to avoid validation errors.
  • Common error messages include 401 Unauthorized (invalid or missing API key), 404 Not Found (project ID does not exist), and 400 Bad Request (invalid invitation data). Resolving these involves correcting credentials, verifying project existence, and validating input data respectively.

Links

Discussion