GitLab API

GitlabTool

Actions1000

Overview

This node interacts with the GitLab API to retrieve user information using the API v4 endpoint. It supports fetching users based on various query parameters such as username, external UID, provider, search terms, and filters like active status, human users, blocked users, and more. This node is useful for scenarios where you need to programmatically access and filter GitLab user data, for example, to generate reports, automate user management, or integrate user data into other systems.

Use Case Examples

  1. Retrieve all active users from a GitLab instance.
  2. Search for a specific user by username.
  3. Filter users created after a certain date.
  4. Get a list of admin users or auditors.

Properties

Name Meaning
Skip Authentication Option to skip authentication when making the API request.
baseUrl The base URL of the GitLab instance to connect to, defaulting to https://gitlab.com.
Method HTTP method to use for the API request, default is GET.
Query Parameters Collection of query parameters to filter and customize the user data retrieval, including username, extern_uid, provider, search, active, humans, external, blocked, created_after, created_before, without_projects, without_project_bots, admins, two_factor, exclude_active, exclude_external, exclude_humans, exclude_internal, order_by, sort, page, per_page, with_custom_attributes, skip_ldap, saml_provider_id, and auditors.

Output

JSON

  • id - Unique identifier of the user.
  • username - Username of the user.
  • name - Full name of the user.
  • state - Account state (e.g., active, blocked).
  • created_at - Timestamp when the user was created.
  • email - Email address of the user.
  • is_admin - Boolean indicating if the user is an admin.
  • two_factor_enabled - Boolean indicating if two-factor authentication is enabled.
  • external - Boolean indicating if the user is an external user.
  • last_sign_in_at - Timestamp of the last sign-in.
  • projects_limit - Limit on the number of projects the user can create.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the baseUrl is correct and accessible.
  • Verify that the API token or credentials have sufficient permissions to read user data.
  • Check that query parameters are correctly formatted and valid according to GitLab API specifications.
  • Common errors include authentication failures, invalid query parameters, and network connectivity issues. Resolving these typically involves verifying credentials, adjusting parameters, and ensuring network access.

Links

Discussion