summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorNejc Habjan <hab.nejc@gmail.com>2021-05-14 23:17:18 +0200
committerNejc Habjan <hab.nejc@gmail.com>2021-05-25 23:07:54 +0200
commitfb0b083a0e536a6abab25c9ad377770cc4290fe9 (patch)
tree9819ff138d3deb9a17046e091afc8db0274db697 /docs/gl_objects
parent7824811e1cb99a0397149b74b0950441cdc21eda (diff)
downloadgitlab-fb0b083a0e536a6abab25c9ad377770cc4290fe9.tar.gz
feat(objects): add support for billable members
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/groups.rst20
1 files changed, 19 insertions, 1 deletions
diff --git a/docs/gl_objects/groups.rst b/docs/gl_objects/groups.rst
index cd8ab45..9f1b049 100644
--- a/docs/gl_objects/groups.rst
+++ b/docs/gl_objects/groups.rst
@@ -226,11 +226,15 @@ Reference
+ :class:`gitlab.v4.objects.GroupMember`
+ :class:`gitlab.v4.objects.GroupMemberManager`
+ :class:`gitlab.v4.objects.GroupMemberAllManager`
+ + :class:`gitlab.v4.objects.GroupBillableMember`
+ + :class:`gitlab.v4.objects.GroupBillableMemberManager`
+ :attr:`gitlab.v4.objects.Group.members`
+ :attr:`gitlab.v4.objects.Group.members_all`
+ + :attr:`gitlab.v4.objects.Group.billable_members`
-* GitLab API: https://docs.gitlab.com/ce/api/groups.html
+* GitLab API: https://docs.gitlab.com/ce/api/members.html
+Billable group members are only available in GitLab EE.
Examples
--------
@@ -270,6 +274,20 @@ Remove a member from the group::
# or
member.delete()
+List billable members of a group (top-level groups only)::
+
+ billable_members = group.billable_members.list()
+
+Remove a billable member from the group::
+
+ group.billable_members.delete(member_id)
+ # or
+ billable_member.delete()
+
+List memberships of a billable member::
+
+ billable_member.memberships.list()
+
LDAP group links
================