GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

Overview

This node operation allows users to retrieve user information from the GitLab API v4. It supports fetching a list of users or a single user based on various query parameters such as username, external UID, provider, and filters like active status, human users, blocked users, and more. This operation is useful for automating user management tasks, auditing user accounts, or integrating GitLab user data into other workflows.

Use Case Examples

  1. Fetch all active users from a GitLab instance.
  2. Search for a specific user by username.
  3. Retrieve users filtered by creation date or admin status.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip authentication when making the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to connect to, defaulting to https://gitlab.com.
Method The HTTP method to use for the API request, defaulting to GET.
Query Parameters A collection of optional query parameters to filter and customize the user data retrieval, such as username, extern_uid, provider, search, active, humans, external, blocked, created_after, created_before, without_projects, admins, two_factor, order_by, sort, page, per_page, and others.

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).
  • created_at - The timestamp when the user was created.
  • email - The email address of the user.
  • is_admin - Indicates if the user has admin privileges.
  • two_factor_enabled - Indicates if two-factor authentication is enabled for the user.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the baseUrl is correct and accessible from the network where the node runs.
  • Verify that the GitLab API key credential has sufficient permissions to read user data.
  • Check that query parameters are correctly formatted and valid according to GitLab API documentation.
  • If skipping authentication, ensure the GitLab instance allows unauthenticated requests for user data.

Links

Discussion