GitLab API

GitlabTool
Join our community

Actions1000

Overview

This node operation allows updating the job token scope settings of a specific project in GitLab via the GitLab API. It is useful for managing project-level job token permissions programmatically, such as enabling or disabling job token access for CI/CD pipelines within a project.

Use Case Examples

  1. Updating the job token scope of a project to restrict or allow job token usage in CI/CD pipelines.
  2. Automating project configuration changes related to job token permissions in GitLab.

Properties

Name Meaning
Skip Authentication Option to skip API authentication for the request.
Authentication The authentication method used for the API request, typically an API key or token.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, default is GET but PATCH is relevant for this operation.
Path Parameters Parameters included in the API request path, specifically the project ID to identify which project's job token scope to update.

Output

JSON

  • id - The ID of the project whose job token scope was updated.
  • job_token_scope - The updated job token scope settings of the project.

Dependencies

  • GitLab API authentication token

Troubleshooting

  • Ensure the project ID provided in the path parameters is valid and accessible with the provided authentication token.
  • Verify that the authentication token has sufficient permissions to update project settings in GitLab.
  • Check the base URL to ensure it points to the correct GitLab instance, especially if using a self-hosted GitLab server.
  • If skipping authentication, ensure the API endpoint allows unauthenticated requests, which is uncommon for this operation.

Links

Discussion