GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation retrieves all members of a specified GitLab group using the GitLab API. It is useful for scenarios where you need to list or manage group members, such as auditing group membership, synchronizing members with another system, or displaying member information in a dashboard. For example, you can fetch all members of a project team to verify access or generate reports.

Use Case Examples

  1. Fetch all members of a GitLab group by providing the group ID.
  2. Filter group members by state (e.g., active or awaiting) to manage membership status.
  3. Search for specific members within a group using a query string.

Properties

Name Meaning
Skip Authentication Option to skip API authentication for the request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key.
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.
Query Parameters Collection of optional query parameters to filter or paginate the members list.
Path Parameters Path parameters required for the API endpoint, specifically the group ID.

Output

JSON

  • id - Unique identifier of the group member.
  • username - Username of the group member.
  • name - Full name of the group member.
  • state - Membership state (e.g., active, awaiting).
  • access_level - Access level of the member within the group.
  • created_at - Timestamp when the membership was created.
  • expires_at - Expiration date of the membership, if any.
  • avatar_url - URL to the member's avatar image.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the provided group ID is correct and the authenticated user has permission to access the group's members.
  • Check that the base URL is correctly set to the GitLab instance you are querying.
  • If using query parameters, verify their format and values are valid according to the GitLab API documentation.
  • Authentication errors may occur if the API key is missing, invalid, or lacks sufficient permissions.

Links

Discussion