GitLab API icon

GitLab API

Gitlab

Actions917

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 group to verify permissions or generate reports on group composition.

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 filter by name or username.
  3. Retrieve members with specific user IDs or exclude certain users from the results.
  4. Paginate through group members by specifying page number and items per page.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request, useful for public or unauthenticated access scenarios.
Authentication Type of authentication used for the request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance to which the API requests are sent, defaulting to https://gitlab.com.
Method HTTP method used for the API request, defaulting to GET for this operation.
Parameter Schema Defines the parameters accepted by the API endpoint, 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 and control the API response, including search query, user IDs to include or skip, seat info display, SAML identity filter, and pagination controls.
Path Parameters Collection of path parameters required by the API endpoint, specifically the group ID to identify the target group.

Output

JSON

  • id - Unique identifier of the group member.
  • username - Username of the group member.
  • name - Full name of the group member.
  • state - State of the member (e.g., active, blocked).
  • access_level - Access level of the member within the group.
  • created_at - Timestamp when the member was added to the group.
  • expires_at - Expiration date of the member's access, if any.
  • avatar_url - URL to the member's avatar image.
  • web_url - URL to the member's profile page.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the group ID path parameter is correctly set; missing or incorrect ID will cause request failures.
  • Verify that the API key credential has sufficient permissions to access group member information.
  • Check query parameter formats, especially arrays like user_ids and skip_users, to ensure they are correctly formatted as comma-separated strings if required by the API.
  • Pagination parameters (page and per_page) should be valid integers; invalid values may cause errors or unexpected results.

Links

Discussion