summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2017-11-10 17:35:34 +0100
committerGauvain Pocentek <gauvain@pocentek.net>2017-11-10 17:35:34 +0100
commit8fec612157e4c15f587c11efc98e7e339dfcff28 (patch)
treeb1b9452bfce982003324fca9fc92ecbc9c085770 /docs
parent700e84f3ea1a8e0f99775d02cd1a832d05d3ec8d (diff)
downloadgitlab-8fec612157e4c15f587c11efc98e7e339dfcff28.tar.gz
Add support for impersonation tokens API
Closes #363
Diffstat (limited to 'docs')
-rw-r--r--docs/gl_objects/users.py19
-rw-r--r--docs/gl_objects/users.rst36
2 files changed, 55 insertions, 0 deletions
diff --git a/docs/gl_objects/users.py b/docs/gl_objects/users.py
index da516e6..e452217 100644
--- a/docs/gl_objects/users.py
+++ b/docs/gl_objects/users.py
@@ -115,3 +115,22 @@ attr.delete()
# or
user.customeattributes.delete(attr_key)
# end ca delete
+
+# it list
+i_t = user.impersonationtokens.list(state='active')
+i_t = user.impersonationtokens.list(state='inactive')
+# end it list
+
+# it get
+i_t = user.impersonationtokens.get(i_t_id)
+# end it get
+
+# it create
+i_t = user.impersonationtokens.create({'name': 'token1', 'scopes': ['api']})
+# use the token to create a new gitlab connection
+user_gl = gitlab.Gitlab(gitlab_url, private_token=i_t.token)
+# end it create
+
+# it delete
+i_t.delete()
+# end it delete
diff --git a/docs/gl_objects/users.rst b/docs/gl_objects/users.rst
index 4e22491..19612dd 100644
--- a/docs/gl_objects/users.rst
+++ b/docs/gl_objects/users.rst
@@ -106,6 +106,42 @@ Delete a custom attribute for a user:
:start-after: # ca list
:end-before: # end ca list
+User impersonation tokens
+=========================
+
+References
+----------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.UserImpersonationToken`
+ + :class:`gitlab.v4.objects.UserImpersonationTokenManager`
+ + :attr:`gitlab.v4.objects.User.impersontaiontokens`
+
+List impersonation tokens for a user:
+
+.. literalinclude:: users.py
+ :start-after: # it list
+ :end-before: # end it list
+
+Get an impersonation token for a user:
+
+.. literalinclude:: users.py
+ :start-after: # it get
+ :end-before: # end it get
+
+Create and use an impersonation token for a user:
+
+.. literalinclude:: users.py
+ :start-after: # it create
+ :end-before: # end it create
+
+Revoke (delete) an impersonation token for a user:
+
+.. literalinclude:: users.py
+ :start-after: # it list
+ :end-before: # end it list
+
Current User
============