summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorNejc Habjan <hab.nejc@gmail.com>2020-02-22 22:55:50 +0100
committerNejc Habjan <hab.nejc@gmail.com>2020-02-22 23:00:29 +0100
commitc313c2b01d796418539e42d578fed635f750cdc1 (patch)
tree7b53057dc000d06b1929a02b11ef929a0ff4be04 /docs/gl_objects
parente8f0921d164c4b7db78e2f62e75eb32094b4456e (diff)
downloadgitlab-c313c2b01d796418539e42d578fed635f750cdc1.tar.gz
feat: add support for user memberships API (#1009)
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/users.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/gl_objects/users.rst b/docs/gl_objects/users.rst
index 3e71ac4..3aa783e 100644
--- a/docs/gl_objects/users.rst
+++ b/docs/gl_objects/users.rst
@@ -153,6 +153,33 @@ Revoke (delete) an impersonation token for a user::
i_t.delete()
+
+User memberships
+=========================
+
+References
+----------
+
+* v4 API:
+
+ + :class:`gitlab.v4.objects.UserMembership`
+ + :class:`gitlab.v4.objects.UserMembershipManager`
+ + :attr:`gitlab.v4.objects.User.memberships`
+
+* GitLab API: https://docs.gitlab.com/ee/api/users.html#user-memberships-admin-only
+
+List direct memberships for a user::
+
+ memberships = user.memberships.list()
+
+List only direct project memberships::
+
+ memberships = user.memberships.list(type='Project')
+
+List only direct group memberships::
+
+ memberships = user.memberships.list('Namespace')
+
Current User
============