GitLab API

GitlabTool
Join our community

Actions905

Overview

This node operation authenticates a user for Conan packages in a specific GitLab project using the GitLab API. It is useful for scenarios where you need to verify user credentials or permissions related to Conan package management within a GitLab project. For example, it can be used in CI/CD pipelines or automation workflows to ensure that a user is authorized to access or manage Conan packages in a project.

Use Case Examples

  1. Authenticate a user to access Conan packages in a GitLab project before performing package upload or download operations.
  2. Verify user permissions for Conan package management in a GitLab project as part of an automated deployment process.

Properties

Name Meaning
Skip Authentication If set to true, the node will skip the authentication step.
Authentication The authentication method used, defaulting to GitLab API authentication. Hidden unless Skip Authentication is false.
baseUrl The base URL of the GitLab instance, defaulting to https://gitlab.com.
Method The HTTP method used for the request, defaulting to GET.
Path Parameters The path parameters for the request, specifically the project ID or URL-encoded path required to identify the GitLab project.

Output

JSON

  • id - The ID or URL-encoded path of the GitLab project used for authentication.
  • authenticatedUser - Details of the authenticated user returned by the API.
  • token - Authentication token or credentials returned upon successful user authentication.

Dependencies

  • GitLab API authentication credential

Troubleshooting

  • Ensure the project ID or URL-encoded path is correctly provided in the path parameters; otherwise, the API call will fail.
  • If authentication is skipped, the request may fail due to lack of valid credentials.
  • Verify that the GitLab API credential is correctly configured and has the necessary permissions to authenticate users for Conan packages.
  • Common error messages include 401 Unauthorized (invalid or missing credentials) and 404 Not Found (incorrect project ID or path). Resolving these involves checking credentials and path parameters.

Links

Discussion