GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows users to send invitations to a specific group in GitLab 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 join a GitLab group, which can be beneficial in team collaboration and project management scenarios.

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 users for a GitLab group as part of an onboarding workflow.

Properties

Name Meaning
Skip Authentication Determines whether to skip the authentication process for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent, defaulting to https://gitlab.com.
Method The HTTP method to use for the API request, defaulting to GET but can be set to POST, PUT, DELETE, HEAD, or PATCH.
Path Parameters Parameters to specify the group ID in the API request path, required to identify the target group for the invitation.

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 - The timestamp when the invitation was created.
  • invited_by - Information about the user who sent the invitation.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the group ID provided in the path parameters is correct and the authenticated user has permission to invite members to the group.
  • Verify that the base URL is correctly set to the GitLab instance you are working with.
  • If skipping authentication, ensure the API endpoint allows unauthenticated requests, otherwise authentication errors will occur.
  • Common error messages include 401 Unauthorized (due to missing or invalid API key) and 404 Not Found (if the group ID does not exist).

Links

Discussion