summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFabio Huser <fabio.huser@siemens.com>2022-01-09 14:43:45 +0100
committerJohn Villalovos <john@sodarock.com>2022-01-09 08:44:09 -0800
commitc01b7c494192c5462ec673848287ef2a5c9bd737 (patch)
treec99ef98aed276746763ce941c767310162e85148 /docs
parent73ae9559dc7f4fba5c80862f0f253959e60f7a0c (diff)
downloadgitlab-c01b7c494192c5462ec673848287ef2a5c9bd737.tar.gz
feat: add support for Group Access Token API
See https://docs.gitlab.com/ee/api/group_access_tokens.html
Diffstat (limited to 'docs')
-rw-r--r--docs/api-objects.rst1
-rw-r--r--docs/gl_objects/group_access_tokens.rst34
2 files changed, 35 insertions, 0 deletions
diff --git a/docs/api-objects.rst b/docs/api-objects.rst
index a36c1c3..5349148 100644
--- a/docs/api-objects.rst
+++ b/docs/api-objects.rst
@@ -24,6 +24,7 @@ API examples
gl_objects/features
gl_objects/geo_nodes
gl_objects/groups
+ gl_objects/group_access_tokens
gl_objects/issues
gl_objects/keys
gl_objects/boards
diff --git a/docs/gl_objects/group_access_tokens.rst b/docs/gl_objects/group_access_tokens.rst
new file mode 100644
index 0000000..390494f
--- /dev/null
+++ b/docs/gl_objects/group_access_tokens.rst
@@ -0,0 +1,34 @@
+#####################
+Group Access Tokens
+#####################
+
+Get a list of group access tokens
+
+References
+----------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.GroupAccessToken`
+ + :class:`gitlab.v4.objects.GroupAccessTokenManager`
+ + :attr:`gitlab.Gitlab.group_access_tokens`
+
+* GitLab API: https://docs.gitlab.com/ee/api/group_access_tokens.html
+
+Examples
+--------
+
+List group access tokens::
+
+ access_tokens = gl.groups.get(1, lazy=True).access_tokens.list()
+ print(access_tokens[0].name)
+
+Create group access token::
+
+ access_token = gl.groups.get(1).access_tokens.create({"name": "test", "scopes": ["api"]})
+
+Revoke a group access tokens::
+
+ gl.groups.get(1).access_tokens.delete(42)
+ # or
+ access_token.delete()