GitLab API

GitlabTool

Actions905

Overview

This node interacts with the GitLab API to perform the operation of posting a support PIN for the authenticated user. It is useful in scenarios where a user needs to generate or update a support PIN via the GitLab API, typically for support or security purposes.

Use Case Examples

  1. A user wants to programmatically generate a support PIN for their GitLab account to provide to support staff.
  2. Automating the process of updating the support PIN as part of a larger workflow involving GitLab user management.

Properties

Name Meaning
Skip Authentication Determines whether to skip the authentication step for the API request.
Authentication Specifies the authentication method to use, defaulting to GitLab API key authentication.
baseUrl The base URL of the GitLab instance to which the API request is sent.
Method The HTTP method used for the API request, defaulting to GET but can be POST, PUT, DELETE, HEAD, or PATCH.
Parameter Schema Hidden property for the parameter schema of the operation, used internally.
Request Body Schema Hidden property for the request body schema of the operation, used internally.
Request Path The API endpoint path for posting the user support PIN, fixed to '/api/v4/user/support_pin'.

Output

JSON

  • response - The JSON response from the GitLab API after posting the user support PIN, typically containing the support PIN details or status.

Dependencies

  • GitLab API key credential

Troubleshooting

  • Ensure the GitLab API key credential is correctly configured and has the necessary permissions to post a user support PIN.
  • Verify the baseUrl is correct and accessible, especially if using a self-hosted GitLab instance.
  • Check that the HTTP method is set to POST for this operation, as other methods may not be supported for posting a support PIN.
  • If authentication is skipped, the request may fail due to lack of authorization.

Links

Discussion