Skip to content

Commit 188781c

Browse files
committed
feat: add share/unshare group with group
1 parent 1606310 commit 188781c

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

docs/gl_objects/groups.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,11 @@ Remove a group::
7474
# or
7575
group.delete()
7676

77+
Share/unshare the group with a group::
78+
79+
group.share(group2.id, gitlab.DEVELOPER_ACCESS)
80+
group.unshare(group2.id)
81+
7782
Import / Export
7883
===============
7984

gitlab/v4/objects.py

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1467,6 +1467,44 @@ def ldap_sync(self, **kwargs):
14671467
path = "/groups/%s/ldap_sync" % self.get_id()
14681468
self.manager.gitlab.http_post(path, **kwargs)
14691469

1470+
@cli.register_custom_action("Group", ("group_id", "group_access"), ("expires_at",))
1471+
@exc.on_http_error(exc.GitlabCreateError)
1472+
def share(self, group_id, group_access, expires_at=None, **kwargs):
1473+
"""Share the group with a group.
1474+
1475+
Args:
1476+
group_id (int): ID of the group.
1477+
group_access (int): Access level for the group.
1478+
**kwargs: Extra options to send to the server (e.g. sudo)
1479+
1480+
Raises:
1481+
GitlabAuthenticationError: If authentication is not correct
1482+
GitlabCreateError: If the server failed to perform the request
1483+
"""
1484+
path = "/groups/%s/share" % self.get_id()
1485+
data = {
1486+
"group_id": group_id,
1487+
"group_access": group_access,
1488+
"expires_at": expires_at,
1489+
}
1490+
self.manager.gitlab.http_post(path, post_data=data, **kwargs)
1491+
1492+
@cli.register_custom_action("Group", ("group_id",))
1493+
@exc.on_http_error(exc.GitlabDeleteError)
1494+
def unshare(self, group_id, **kwargs):
1495+
"""Delete a shared group link within a group.
1496+
1497+
Args:
1498+
group_id (int): ID of the group.
1499+
**kwargs: Extra options to send to the server (e.g. sudo)
1500+
1501+
Raises:
1502+
GitlabAuthenticationError: If authentication is not correct
1503+
GitlabDeleteError: If the server failed to perform the request
1504+
"""
1505+
path = "/groups/%s/share/%s" % (self.get_id(), group_id)
1506+
self.manager.gitlab.http_delete(path, **kwargs)
1507+
14701508

14711509
class GroupManager(CRUDMixin, RESTManager):
14721510
_path = "/groups"

0 commit comments

Comments
 (0)