GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation triggers an LDAP synchronization for a specific GitLab group by making a POST request to the GitLab API endpoint `/api/v4/groups/{id}/ldap_sync`. It is useful for automating the synchronization of group membership and permissions from an LDAP directory to GitLab groups, ensuring that group data is up-to-date with the organization's LDAP server.

Use Case Examples

  1. Automatically sync a GitLab group with LDAP after changes in the LDAP directory.
  2. Schedule regular LDAP syncs for GitLab groups to maintain consistent access control.

Properties

Name Meaning
Skip Authentication Determines whether to skip API 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 POST for this operation.
Path Parameters Parameters to be included in the request path, specifically the group ID to sync.

Output

JSON

  • id - The ID of the GitLab group for which the LDAP sync was triggered.
  • status - The status or result of the LDAP synchronization request.

Dependencies

  • GitLab API authentication token or credentials

Troubleshooting

  • Ensure the group ID provided in the path parameters is valid and exists in the GitLab instance.
  • Verify that the API token or credentials have sufficient permissions to perform LDAP sync operations on groups.
  • Check the base URL to confirm it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages may include authentication failures, invalid group ID, or insufficient permissions. Resolving these typically involves verifying credentials, group existence, and API access rights.

Links

Discussion