GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

Overview

This node operation retrieves a list of users associated with a specific GitLab project by its ID or URL-encoded path. It is useful for scenarios where you need to manage or analyze project members, such as fetching user details for project collaboration or auditing purposes. For example, you can use it to get all users of a project to send notifications or to check user permissions.

Use Case Examples

  1. Fetch all users of a project with ID '123' to display in a dashboard.
  2. Search for users in a project matching a specific search term to filter project members.
  3. Paginate through project users to process large member lists in batches.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
Authentication Type of authentication used, default is GitLab API key.
baseUrl Base URL of the GitLab instance, default is https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Parameter Schema Defines the parameters for the API call including project ID, search term, user IDs to skip, pagination page, and items per page.
Query Parameters Collection of optional query parameters to filter and paginate the user list, including search term, skip_users, page number, and items per page.
Path Parameters Collection of path parameters including the project ID or URL-encoded path to identify the project.

Output

JSON

  • id - The ID or URL-encoded path of the project used in the request path.
  • search - Search term used to filter users by matching criteria.
  • skip_users - 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

Troubleshooting

  • Ensure the project ID or URL-encoded path is correct and accessible with the provided API key.
  • Check that the API key has sufficient permissions to read project users.
  • Verify that query parameters like page and per_page are valid integers.
  • If skipping authentication, ensure the GitLab instance allows unauthenticated access to project users.

Links

Discussion