From c313c2b01d796418539e42d578fed635f750cdc1 Mon Sep 17 00:00:00 2001 From: Nejc Habjan Date: Sat, 22 Feb 2020 22:55:50 +0100 Subject: feat: add support for user memberships API (#1009) --- docs/gl_objects/users.rst | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) (limited to 'docs/gl_objects') 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 ============ -- cgit v1.2.1 From 33889bcbedb4aa421ea5bf83c13abe3168256c62 Mon Sep 17 00:00:00 2001 From: Nejc Habjan Date: Sat, 22 Feb 2020 23:09:53 +0100 Subject: fix(docs): fix typo in user memberships example --- docs/gl_objects/users.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/gl_objects') diff --git a/docs/gl_objects/users.rst b/docs/gl_objects/users.rst index 3aa783e..5b1cf3d 100644 --- a/docs/gl_objects/users.rst +++ b/docs/gl_objects/users.rst @@ -178,7 +178,7 @@ List only direct project memberships:: List only direct group memberships:: - memberships = user.memberships.list('Namespace') + memberships = user.memberships.list(type='Namespace') Current User ============ -- cgit v1.2.1