GitLab API icon

GitLab API

Gitlab

Actions880

Overview

This node interacts with the GitLab API to retrieve user information via the /api/v3/user endpoint. It supports making HTTP requests with various methods (GET, POST, PUT, DELETE, HEAD, PATCH) to the specified path, primarily used to get details about the authenticated user or user data from GitLab. This is useful in automation workflows where user data from GitLab needs to be fetched or manipulated programmatically.

Use Case Examples

  1. Fetching the current authenticated user's profile information from GitLab.
  2. Automating user data retrieval for integration with other systems or reporting.

Properties

Name Meaning
Skip Authentication Determines whether to skip the authentication process 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, defaulting 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 schema of parameters used in the request, specific to the getApiV3User operation.
Request Body Schema Hidden property for the schema of the request body, specific to the getApiV3User operation.
Request Path The API endpoint path for the request, set to /api/v3/user for this operation.

Output

JSON

  • id - The unique identifier of the user.
  • username - The username of the user.
  • email - The email address of the user.
  • name - The full name of the user.
  • state - The state of the user account (e.g., active, blocked).
  • created_at - The 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 Skype contact of the user.
  • linkedin - The LinkedIn profile URL of the user.
  • twitter - The Twitter handle of the user.
  • website_url - The personal or professional website URL of the user.
  • organization - The organization the user belongs to.
  • last_sign_in_at - The timestamp of the user's last sign-in.
  • confirmed_at - The timestamp when the user was confirmed.
  • last_activity_on - The date of the user's last activity.
  • color_scheme_id - The ID of the user's selected color scheme.
  • projects_limit - The maximum number of projects the user can create.
  • current_sign_in_at - The timestamp of the user's current sign-in.
  • identities - An array 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 for the user.
  • external - Boolean indicating if the user is an external user.
  • private_profile - Boolean indicating if the user's profile is private.
  • is_admin - Boolean indicating if the user has admin privileges.
  • note - Additional notes about the user.
  • theme_id - The ID of the user's selected theme.
  • last_sign_in_ip - The IP address from which the user last signed in.
  • confirmed - Boolean indicating if the user is confirmed.
  • email_opted_in - Boolean indicating if the user has opted in for emails.
  • notification_level - The user's notification level setting.
  • shared_runners_minutes_limit - The limit on shared runners minutes for the user.
  • extra_shared_runners_minutes_limit - Additional shared runners minutes limit for the user.
  • avatar_url - URL to the user's avatar image.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has the necessary permissions to access user data.
  • Verify the baseUrl is correct and accessible, especially if using a self-hosted GitLab instance.
  • If skipping authentication, be aware that some endpoints may require authentication and could return errors.
  • Common error messages include 401 Unauthorized (check API key and permissions), 404 Not Found (verify the API path and user existence), and 500 Internal Server Error (retry or check GitLab server status).

Links

Discussion