GitLab API

GitlabTool

Actions1000

Overview

This node operation allows users to add SSH certificates to a specific GitLab group by making a POST request to the GitLab API endpoint `/api/v4/groups/{id}/ssh_certificates`. It is useful for managing SSH keys associated with groups in GitLab, enabling secure access control and automation of SSH certificate management within group contexts.

Use Case Examples

  1. Adding an SSH certificate to a GitLab group to enable secure SSH access for group members.
  2. Automating the process of uploading SSH certificates to multiple GitLab groups for consistent access management.

Properties

Name Meaning
Skip Authentication Option to skip API authentication for the request.
Authentication Type of authentication used for the API request, defaulting to GitLab API key authentication.
baseUrl Base URL of the GitLab instance to which the request is sent.
Method HTTP method used for the request, default is GET but POST is used for this operation.
Path Parameters Parameters included in the request path, specifically the group ID to which the SSH certificate will be added.

Output

JSON

  • id - The ID of the GitLab group to which the SSH certificate was added.
  • ssh_certificate - Details of the SSH certificate added to the group, including key data and metadata.

Dependencies

  • GitLab API key credential for authentication

Troubleshooting

  • Ensure the group ID provided in the path parameters is valid and the user has permission to add SSH certificates to the group.
  • Verify that the API key used for authentication has sufficient permissions to manage group SSH certificates.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • Common error messages include authentication failures, invalid group ID, or malformed SSH certificate data. Resolving these involves verifying credentials, input parameters, and request body format.

Links

Discussion