GitLab API

GitlabTool

Actions1000

Overview

This node operation retrieves the billable members of a specific GitLab group using the GitLab API. It is useful for scenarios where you need to manage or analyze the members of a group who are incurring costs, such as for billing or subscription management purposes. For example, you can use this node to fetch a paginated list of billable members, filter by member name, or sort the results based on various criteria like access level or last activity.

Use Case Examples

  1. Fetch the first page of billable members for a group with ID '123'.
  2. Search for a specific subscribed member by name within a group's billable members.
  3. Sort the billable members by their access level in ascending order.

Properties

Name Meaning
Skip Authentication Option to skip authentication for the request.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method HTTP method to use for the request, default is GET.
Query Parameters Optional query parameters to control pagination, filtering, and sorting of the billable members list.
Path Parameters Path parameters including the group ID to specify which group's billable members to retrieve.

Output

JSON

  • id - The unique identifier of the billable member.
  • username - The username of the billable member.
  • name - The full name of the billable member.
  • state - The state of the member (e.g., active, blocked).
  • access_level - The access level of the member within the group.
  • last_sign_in_at - Timestamp of the member's last sign-in.
  • last_activity_on - Date of the member's last activity.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the group ID provided in the path parameters is correct and exists in the GitLab instance.
  • Verify that the API token or credentials have sufficient permissions to access group member information.
  • Check the base URL if using a self-hosted GitLab instance instead of gitlab.com.
  • If pagination parameters are used, ensure they are valid integers and within allowed ranges.
  • Common error messages include 401 Unauthorized (invalid or missing credentials), 404 Not Found (group ID does not exist), and 400 Bad Request (invalid query parameters). Resolving these involves correcting credentials, verifying group existence, and validating input parameters.

Links

Discussion