GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation fetches user data from the GitLab API v4 endpoint `/api/v4/users`. It supports querying users with various filters such as username, external UID, provider, active status, creation date, admin status, and more. This is useful for automating user management tasks, auditing user accounts, or integrating GitLab user data into workflows.

Use Case Examples

  1. Retrieve all active users in a GitLab instance.
  2. Search for a user by username or external UID.
  3. Filter users created after a specific date or only admin users.

Properties

Name Meaning
Skip Authentication If true, the node skips authentication when making the API request.
Authentication The authentication method used for the API request, typically an API key credential.
baseUrl The base URL of the GitLab instance to query, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, default is GET.
Query Parameters Collection of optional filters to refine the user search, such as username, active status, admin status, creation date, pagination, and more.

Output

JSON

  • id - Unique identifier of the user.
  • username - Username of the user.
  • name - Full name of the user.
  • state - Account state (active, blocked, etc.).
  • created_at - Timestamp when the user was created.
  • extern_uid - External authentication provider UID if applicable.
  • provider - External authentication provider name.
  • is_admin - Boolean indicating if the user is an admin.
  • two_factor_enabled - Boolean indicating if two-factor authentication is enabled.
  • custom_attributes - Custom attributes included if requested.

Dependencies

  • Requires GitLab API authentication credentials (API key or token).

Troubleshooting

  • Ensure the GitLab API credentials are valid and have sufficient permissions to read user data.
  • Check the baseUrl is correct and accessible from the network where the node runs.
  • If filtering by date or other parameters, ensure the format matches the API expectations (e.g., ISO 8601 for dates).
  • Common errors include authentication failures (401 Unauthorized) and invalid query parameters (400 Bad Request). Verify parameters and credentials accordingly.

Links

Discussion