GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows adding an email address to a specific user in GitLab by making a POST request to the GitLab API endpoint `/api/v4/users/{id}/emails`. It is useful for managing user email addresses programmatically within GitLab, such as adding secondary emails for notifications or account recovery.

Use Case Examples

  1. Add a secondary email to a GitLab user by specifying the user ID and the email address in the request body.
  2. Automate user email management in GitLab for an organization by integrating this node in workflows.

Properties

Name Meaning
Skip Authentication Option to skip API authentication for the request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is POST.
Path Parameters Parameters to be included in the URL path, specifically the user ID for this operation.

Output

JSON

  • id - The ID of the added email record.
  • email - The email address added to the user.
  • confirmed_at - Timestamp when the email was confirmed.
  • created_at - Timestamp when the email record was created.
  • updated_at - Timestamp when the email record was last updated.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the user ID provided in the path parameters is valid and exists in GitLab.
  • Verify that the API key used for authentication has sufficient permissions to add emails to users.
  • Check the request body schema to ensure the email data is correctly formatted and included.
  • Common error messages may include authentication failures, invalid user ID, or malformed request body. Verify credentials and input data accordingly.

Links

Discussion