GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation performs user authentication against the GitLab API's Conan package registry endpoint. It is useful for scenarios where you need to authenticate a user to access or manage Conan packages hosted on GitLab. For example, it can be used in CI/CD pipelines or automation workflows that require secure access to private Conan packages.

Use Case Examples

  1. Authenticate a user to GitLab's Conan package registry to retrieve an access token for package operations.
  2. Use the node to verify user credentials before performing package uploads or downloads in an automated workflow.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip the authentication step.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the request is sent, defaulting to https://gitlab.com.
Method The HTTP method used for the request, such as GET, POST, PUT, DELETE, HEAD, or PATCH.
Parameter Schema Hidden property for the parameter schema of the request, specific to the operation.
Request Body Schema Hidden property for the request body schema, specific to the operation.
Request Path Hidden property specifying the API endpoint path for the authentication request.

Output

JSON

  • authenticated - Indicates whether the user authentication was successful.
  • token - The authentication token returned upon successful user authentication.
  • user - Details of the authenticated user, such as username and ID.

Dependencies

  • GitLab API key credential

Troubleshooting

  • If authentication fails, verify that the GitLab API key credential is correctly configured and has the necessary permissions.
  • Ensure the baseUrl is correctly set to the GitLab instance URL you intend to authenticate against.
  • Check network connectivity to the GitLab server to avoid request timeouts or connection errors.
  • Common error messages include 401 Unauthorized (invalid credentials) and 404 Not Found (incorrect API path). Verify the request path and method are correct.

Links

Discussion