GitLab API

GitlabTool

Actions905

Overview

This node interacts with the GitLab API to retrieve user information via the API v3 endpoint. It is designed to fetch details about the authenticated user or a specified user by making HTTP requests to the GitLab server. This node is useful in automation workflows where user data from GitLab is needed, such as fetching user profiles, verifying user credentials, or integrating GitLab user data into other systems.

Use Case Examples

  1. Retrieve the current authenticated user's profile information from GitLab.
  2. Fetch user details to verify access permissions in a CI/CD pipeline.
  3. Integrate GitLab user data into a CRM or project management tool for enhanced user tracking.

Properties

Name Meaning
Skip Authentication Determines whether to skip the authentication step when making the API request.
Authentication Specifies the authentication method to use, hidden unless Skip Authentication is false.
baseUrl The base URL of the GitLab instance to which the API requests are sent. Defaults to https://gitlab.com.
Method The HTTP method used for the API request, such as GET, POST, PUT, DELETE, HEAD, or PATCH.
Parameter Schema Hidden property for the parameter schema of the API request, specific to the getApiV3User operation.
Request Body Schema Hidden property for the request body schema of the API request, specific to the getApiV3User operation.
Request Path Hidden property specifying the API endpoint path, set to /api/v3/user for the getApiV3User operation.

Output

JSON

  • id - The unique identifier of the user.
  • username - The username of the user.
  • name - The full name of the user.
  • state - The state of the user account (e.g., active, blocked).
  • avatar_url - URL to the user's avatar image.
  • web_url - URL to the user's GitLab profile page.
  • created_at - Timestamp when the user account was created.
  • bio - The biography or description of the user.
  • location - The location of the user.
  • public_email - The public email address of the user.
  • skype - The user's Skype contact.
  • linkedin - The user's LinkedIn profile.
  • twitter - The user's Twitter handle.
  • website_url - The user's personal or professional website URL.
  • organization - The organization the user belongs to.
  • last_sign_in_at - Timestamp of the user's last sign-in.
  • confirmed_at - Timestamp when the user's email was confirmed.
  • last_activity_on - Date of the user's last activity.
  • email - The user's email address.
  • theme_id - The theme ID set by the user.
  • color_scheme_id - The color scheme ID set by the user.
  • projects_limit - The maximum number of projects the user can create.
  • current_sign_in_at - Timestamp of the current sign-in.
  • identities - List of identities associated with the user.
  • can_create_group - Boolean indicating if the user can create groups.
  • can_create_project - Boolean indicating if the user can create projects.
  • two_factor_enabled - Boolean indicating if two-factor authentication is enabled.
  • external - Boolean indicating if the user is an external user.
  • private_profile - Boolean indicating if the user's profile is private.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the GitLab API credentials are correctly configured and have the necessary permissions to access user data.
  • If the node returns authentication errors, verify that the 'Skip Authentication' option is not enabled unless intended.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • If the API endpoint path or method is modified, ensure it matches the GitLab API v3 specifications to avoid request failures.

Links

Discussion