GitLab API icon

GitLab API

Gitlab
Join our community

Actions917

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 team members, filtering members by certain criteria, or integrating member data into workflows. For example, you can fetch all members of a project, search members by name, or filter by user IDs.

Use Case Examples

  1. Fetch all members of a project by providing the project ID.
  2. Search for members in a project using a query string to find specific users.
  3. Filter project members by user IDs or exclude certain users from the results.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for 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 connect to, defaulting to https://gitlab.com.
Method The HTTP method used for the request, default is GET.
Parameter Schema Defines the parameters for the API call including path and query parameters such as project ID, search query, user IDs, pagination, and filters.
Query Parameters Collection of optional query parameters to filter and paginate the members list, including search query, user IDs, skip users, seat info, SAML identity filter, page number, and items per page.
Path Parameters Collection of path parameters, specifically the project ID to identify the project whose members are being retrieved.

Output

JSON

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

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID is valid and accessible with the provided authentication.
  • Check that the API token has sufficient permissions to read project members.
  • Verify that query parameters are correctly formatted, especially arrays like user_ids and skip_users.
  • Handle pagination properly if the number of members exceeds the per_page limit.

Links

Discussion