GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves a list of users associated with a specific GitLab project by calling the GitLab API endpoint `/api/v4/projects/{id}/users`. It supports filtering users by search criteria, excluding specific user IDs, and paginating the results. This operation is useful for managing project members, auditing user access, or integrating user data from GitLab projects into workflows.

Use Case Examples

  1. Fetch all users of a GitLab project to synchronize project members with an external system.
  2. Search for users in a project matching a specific name or username to automate user management tasks.
  3. Paginate through project users to process large member lists in batches.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the API request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance to which the API request is sent.
Method HTTP method used for the API request, default is GET.
Parameter Schema Defines the parameters for the API request including project ID, search query, user IDs to skip, page number, and items per page.
Query Parameters Collection of optional query parameters to filter and paginate the user list, including search string, skip_users IDs, page number, and items per page.
Path Parameters Path parameter specifying the project ID or URL-encoded path to identify the project.

Output

JSON

  • id - The ID or URL-encoded path of the GitLab project used in the request path.
  • users - Array of user objects returned by the API, representing users associated with the project.
  • search - Optional search string used to filter users by matching criteria.
  • skip_users - Optional list of user IDs to exclude from the results.
  • page - Current page number of the paginated results.
  • per_page - Number of user items returned per page.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and accessible with the authenticated user.
  • Verify that the GitLab API key credential is valid and has sufficient permissions to access project user data.
  • Check the format of query parameters, especially `skip_users` which should be an array of integers.
  • Handle pagination properly to avoid missing users if the project has many members.

Links

Discussion