GitLab API

GitlabTool

Actions1000

Overview

This node operation retrieves users belonging to a specific GitLab group by making an API call to the GitLab endpoint `/api/v4/groups/{id}/users`. It supports filtering and pagination options, allowing users to search by name, email, or username, filter active users, include SAML users or service accounts, and control the page and number of results per page. This operation is useful for managing group memberships, auditing group users, or integrating GitLab group user data into workflows.

Use Case Examples

  1. Retrieve all users in a GitLab group with ID 123, filtering only active users.
  2. Search for users in a GitLab group by username or email.
  3. Paginate through users in a large GitLab group to process them in batches.

Properties

Name Meaning
Skip Authentication Whether to skip authentication for the API request (boolean). Defaults to false.
Authentication The authentication method used for the API request, hidden unless Skip Authentication is false. Defaults to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent. Defaults to https://gitlab.com.
Method The HTTP method used for the API request. Defaults to GET. Options include GET, POST, PUT, DELETE, HEAD, PATCH.
Query Parameters Optional query parameters to filter and paginate the users list.
Path Parameters Path parameters for the API request, specifically the group ID.

Output

JSON

  • id - The unique identifier of the user in the group.
  • username - The username of the user.
  • name - The full name of the user.
  • state - The state of the user (e.g., active, blocked).
  • access_level - The access level of the user within the group.
  • expires_at - The expiration date of the user's access to the group, if any.

Dependencies

  • GitLab API key credential for authentication unless Skip Authentication is enabled.

Troubleshooting

  • Ensure the group ID path parameter is provided and valid; missing or invalid ID will cause API errors.
  • Verify that the authentication credentials are correctly configured unless Skip Authentication is enabled.
  • Check that the base URL is correct for the GitLab instance being accessed.
  • If filtering by active users or other query parameters, ensure the values are correctly formatted (e.g., boolean values as true/false).
  • API rate limits or permission issues may cause errors; verify API token permissions and usage limits.

Links

  • GitLab API - List Group Users - Official GitLab API documentation for listing users in a group, detailing available query parameters and response structure.

Discussion