GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves members of a specific GitLab project using the GitLab API v4. It is useful for scenarios where you need to manage or analyze project membership, such as auditing project access, managing user roles, or integrating project member data into other workflows. For example, you can fetch all members of a project to verify permissions or to synchronize member lists with another system.

Use Case Examples

  1. Fetch all members of a GitLab project by providing the project ID.
  2. Search for specific members within a project using a query string.
  3. Filter members by user IDs or exclude certain users from the results.
  4. Paginate through project members to handle large member lists.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the request (boolean). Defaults to false.
Authentication The authentication method used for the request, typically an API key credential for GitLab.
baseUrl The base URL of the GitLab instance to connect to, defaulting to https://gitlab.com.
Method The HTTP method to use for the request, default is GET.
Query Parameters Optional query parameters to filter and control the members list, including search query, user IDs to include or skip, seat info display, SAML identity filter, and pagination options.
Path Parameters Path parameters including the project ID to specify which project's members to retrieve.

Output

JSON

  • id - The unique identifier of the project member.
  • username - The username of the project member.
  • name - The full name of the project member.
  • state - The state of the member (e.g., active, blocked).
  • access_level - The access level of the member within the project.
  • created_at - The date and time when the member was added to the project.
  • expires_at - The expiration date of the member's access, if any.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the project ID provided in the path parameters is correct and the project exists.
  • Verify that the API key credential has sufficient permissions to access project members.
  • Check the format of query parameters, especially arrays like user_ids and skip_users, to ensure they are correctly formatted as comma-separated strings if required.
  • If pagination parameters (page, per_page) are used, ensure they are valid integers to avoid errors.

Links

Discussion