GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation retrieves members of a specific GitLab group using the GitLab API v4. It is useful for scenarios where you need to manage or analyze group membership, such as auditing group access, syncing members with other systems, or filtering members based on criteria like user IDs or SAML identity linkage. For example, you can fetch all members of a project team or filter members who have linked SAML identities for security reviews.

Use Case Examples

  1. Fetch all members of a GitLab group by specifying the group ID.
  2. Search for members within a group using a query string to find specific users.
  3. Retrieve members with linked SAML identities to verify authentication methods.

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 which the API request is sent.
Method The HTTP method used for the API request, defaulting to GET.
Parameter Schema Defines the parameters for the API request including path and query parameters such as group ID, search query, user IDs, pagination, and filters.
Query Parameters Collection of optional query parameters to filter or paginate the members list, including search query, user IDs to include or skip, seat info display, SAML identity filter, page number, and items per page.
Path Parameters Collection of path parameters, specifically the group ID to identify the group whose members are being retrieved.

Output

JSON

  • members - Array of member objects retrieved from the GitLab group.

Dependencies

  • GitLab API authentication token or API key credential

Troubleshooting

  • Ensure the group ID provided in the path parameters is valid and accessible with the provided authentication.
  • Check that the API token or credentials have sufficient permissions to read group members.
  • Verify that query parameters are correctly formatted, especially arrays like user_ids and skip_users.
  • If pagination parameters (page, per_page) are used, ensure they are within valid ranges to avoid empty or incomplete results.

Links

Discussion