summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorMax Wittig <max.wittig@siemens.com>2020-02-24 13:56:58 +0100
committerGitHub <noreply@github.com>2020-02-24 13:56:58 +0100
commitf071390dadc4422c7d3cf77171334a617cfd9908 (patch)
tree32eb77c15ef0b3df6e62ca0fae68c8701b255a1f /docs/gl_objects
parent292dfff5050515d07b2e4f2231e2ec17dc2d5589 (diff)
parent33889bcbedb4aa421ea5bf83c13abe3168256c62 (diff)
downloadgitlab-f071390dadc4422c7d3cf77171334a617cfd9908.tar.gz
Merge pull request #1026 from nejch/feat/user-memberships
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..5b1cf3d 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(type='Namespace')
+
Current User
============