Admin Token API: Revoke pipeline trigger tokens
-
Please check this box if this contribution uses AI-generated content (including content generated by GitLab Duo features) as outlined in the GitLab DCO & CLA. As a benefit of being a GitLab Community Contributor, you receive complimentary access to GitLab Duo.
What does this MR do and why?
This MR adds support for revocation of pipeline trigger tokens to the Admin token API
. In this case, revoation is done by deleting the token.
Issue: #517491 (closed)
References
MR acceptance checklist
checklist
-
Changelog entry added, if necessary -
Documentation created/updated via this MR -
Documentation reviewed by technical writer or follow-up review issue created -
Tests added for this feature/bug -
Tested in all supported browsers -
Conforms to the code review guidelines -
Conforms to the merge request performance guidelines -
Conforms to the style guides -
Conforms to the javascript style guides -
Conforms to the database guides
How to set up and validate locally
- Enable the feature flag with
rails c
:
Feature.enable(:api_admin_token_revoke)
- You'll need to create a
personal access token
to access the token and thepipeline trigger
token that you'd like to query: - Now you can retrieve information about this token:
curl -k --request POST \
--url 'https://gdk.test:3443/api/v4/admin/token' \
--header 'Authorization: Bearer <Admin Token from Step 2.>' \
--header 'Content-Type: application/json' \
--data '{"token": "glptt-token-from-step-2-2"}'
- Now, revoke the token:
curl -k --request DELETE \
--url 'https://gdk.test:3443/api/v4/admin/token \
--header 'Authorization: Bearer <Admin Token from Step 1.>' \
--header 'Content-Type: application/json' \
--data '{"token": "glptt-token-from-step-2-2"}'
- Query the token again - you should now see that the status changed to
Not Found
, as the trigger no longer exists. You can also see this is in theProjects > Settings > CI / CD > Pipeline Trigger Tokens
.
Related to #517491 (closed)
Edited by Nicholas Wittstruck