GitLab API icon

GitLab API

Gitlab
Join our community

Actions880

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 number of results per page. This operation is useful for managing group memberships, auditing users in a group, or integrating GitLab group user data into workflows.

Use Case Examples

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

Properties

Name Meaning
Skip Authentication Option to skip authentication for the API request, useful for public or unauthenticated access scenarios.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication. Hidden if Skip Authentication is true.
baseUrl The base URL of the GitLab instance to which the API requests are sent, defaulting to https://gitlab.com.
Method HTTP method to use for the API request, defaulting to GET. Options include GET, POST, PUT, DELETE, HEAD, PATCH.
Query Parameters Collection of optional query parameters to filter and paginate the user list. Includes search (string), active (boolean), include_saml_users (boolean), include_service_accounts (boolean), page (integer), and per_page (integer).
Path Parameters Path parameter specifying the group ID to retrieve users from, required for the API call.

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 membership in the group, if set.

Dependencies

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

Troubleshooting

  • Ensure the group ID path parameter is correctly set and is a valid integer.
  • Verify that the API key credential has sufficient permissions to access group user data.
  • Check that the baseUrl is correct and reachable, especially if using a self-hosted GitLab instance.
  • If using query parameters, ensure they are correctly formatted and valid according to the GitLab API documentation.

Links

Discussion