GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node interacts with the GitLab API to perform operations related to the User resource, 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 when a new user is onboarded.
  2. Batch update user emails in GitLab from an external system.

Properties

Name Meaning
Skip Authentication Determines whether to skip authentication for the 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.
Method The HTTP method to use for the request, defaulting to GET but can be set to POST for adding emails.
Parameter Schema Defines the schema for the parameters expected in the request body for the postApiV4UserEmails operation.
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 the status or details of the added emails.

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 correctly set to the GitLab instance URL if using a self-hosted GitLab.
  • Check that the request body matches the expected schema for adding user emails to avoid validation errors.

Links

Discussion