summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/project_access_tokens.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/gl_objects/project_access_tokens.rst b/docs/gl_objects/project_access_tokens.rst
new file mode 100644
index 0000000..850cd25
--- /dev/null
+++ b/docs/gl_objects/project_access_tokens.rst
@@ -0,0 +1,34 @@
+#####################
+Project Access Tokens
+#####################
+
+Get a list of project access tokens
+
+References
+----------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.ProjectAccessToken`
+ + :class:`gitlab.v4.objects.ProjectAccessTokenManager`
+ + :attr:`gitlab.Gitlab.project_access_tokens`
+
+* GitLab API: https://docs.gitlab.com/ee/api/resource_access_tokens.html
+
+Examples
+--------
+
+List project access tokens::
+
+ access_tokens = gl.projects.get(1, lazy=True).access_tokens.list()
+ print(access_tokens[0].name)
+
+Create project access token::
+
+ access_token = gl.projects.get(1).access_tokens.create({"name": "test", "scopes": ["api"]})
+
+Revoke a project access tokens::
+
+ gl.projects.get(1).access_tokens.delete(42)
+ # or
+ access_token.delete()