summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNejc Habjan <nejc.habjan@siemens.com>2022-07-29 13:56:35 +0200
committerJohn Villalovos <john@sodarock.com>2022-07-29 07:42:29 -0700
commit5ea48fc3c28f872dd1184957a6f2385da075281c (patch)
treea1e864df70888b2048a273d8526c7eae62bf1fb1
parent5e1df653e22cfbd1a2c1054d1c9b684f90e8c283 (diff)
downloadgitlab-5ea48fc3c28f872dd1184957a6f2385da075281c.tar.gz
docs: describe self-revoking personal access tokens
-rw-r--r--docs/cli-examples.rst28
-rw-r--r--docs/gl_objects/personal_access_tokens.rst4
2 files changed, 32 insertions, 0 deletions
diff --git a/docs/cli-examples.rst b/docs/cli-examples.rst
index 94ce6c8..167c726 100644
--- a/docs/cli-examples.rst
+++ b/docs/cli-examples.rst
@@ -133,6 +133,34 @@ List deploy tokens for a group:
$ gitlab -v group-deploy-token list --group-id 3
+Personal access tokens
+----------------------
+
+List the current user's personal access tokens (or all users' tokens, if admin):
+
+.. code-block:: console
+
+ $ gitlab -v personal-access-token list
+
+Revoke a personal access token by id:
+
+.. code-block:: console
+
+ $ gitlab personal-access-token delete --id 1
+
+Revoke the personal access token currently used:
+
+.. code-block:: console
+
+ $ gitlab personal-access-token delete --id self
+
+Create a personal access token for a user (admin only):
+
+.. code-block:: console
+
+ $ gitlab -v user-personal-access-token create --user-id 2 \
+ --name personal-access-token --expires-at "2023-01-01" --scopes "api,read_repository"
+
Resource access tokens
----------------------
diff --git a/docs/gl_objects/personal_access_tokens.rst b/docs/gl_objects/personal_access_tokens.rst
index 0704c75..f665182 100644
--- a/docs/gl_objects/personal_access_tokens.rst
+++ b/docs/gl_objects/personal_access_tokens.rst
@@ -40,6 +40,10 @@ Revoke a personal access token by id::
gl.personal_access_tokens.delete(123)
+Revoke the personal access token currently used::
+
+ gl.personal_access_tokens.delete("self")
+
Create a personal access token for a user (admin only)::
user = gl.users.get(25, lazy=True)