GitLab API

GitlabTool
Join our community

Actions905

Overview

This node interacts with the GitLab API to perform operations related to user emails, specifically allowing the addition of user emails via a POST request to the /api/v4/user/emails endpoint. It is useful for automating user email management in GitLab, such as adding new email addresses to a user's account programmatically.

Use Case Examples

  1. Automatically add a new email address to a GitLab user account when a new user is onboarded.
  2. Integrate with a user management system to sync email addresses with GitLab accounts.

Properties

Name Meaning
Skip Authentication Determines whether to skip the authentication step 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 requests are sent, defaulting to https://gitlab.com.
Method The HTTP method to use for the API request, with POST being the relevant method for adding user emails.
Parameter Schema Defines the schema for the parameters required by the postApiV4UserEmails operation, specifically for the request body.
Request Body Schema Defines the schema for the request body for the postApiV4UserEmails operation.
Request Path The API endpoint path for adding user emails, fixed to /api/v4/user/emails.

Output

JSON

  • response - The JSON response from the GitLab API after adding user emails, typically containing details of the added emails or confirmation of the operation.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has the necessary permissions to add user emails.
  • Verify the baseUrl is correct and accessible, especially if using a self-hosted GitLab instance.
  • Check that the request body conforms to the expected schema for adding user emails to avoid validation errors from the API.

Links

Discussion