GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation allows users to add email addresses to their GitLab user account via the GitLab API. It is useful for managing user contact information programmatically, such as adding new email addresses for notifications or account recovery.

Use Case Examples

  1. Adding a new email address to a GitLab user account using the POST method to the /api/v4/user/emails endpoint.
  2. Automating the update of user email addresses in GitLab as part of a user management 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 to which the request is sent, defaulting to https://gitlab.com.
Method HTTP method to use for the request, defaulting to POST for this operation.
Parameter Schema Defines the schema for the request body parameters required by the POST /user/emails endpoint.
Request Body Schema Schema for the request body, specifying the structure of the data sent to the API.
Request Path The API endpoint path for adding user emails, fixed as /api/v4/user/emails.

Output

JSON

  • response - The JSON response from the GitLab API after adding the email address(es) to the user account.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has the necessary permissions to modify 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 emails, including required fields.
  • Common error messages may include authentication failures, permission denied, or invalid request body format. Resolving these typically involves verifying credentials, permissions, and request data format.

Links

Discussion