feat: adds member role methods

SachinKSingh28 · nejch · commit 055557efe9de · 2025-02-14T14:29:41.000+01:00
diff --git a/docs/api-objects.rst b/docs/api-objects.rst
@@ -36,6 +36,7 @@ API examples
    gl_objects/boards
    gl_objects/labels
    gl_objects/notifications
+   gl_objects/member_roles.rst
    gl_objects/merge_trains
    gl_objects/merge_requests
    gl_objects/merge_request_approvals.rst
diff --git a/docs/gl_objects/member_roles.rst b/docs/gl_objects/member_roles.rst
@@ -0,0 +1,71 @@
+############
+Member Roles
+############
+
+You can configure member roles at the instance-level (admin only), or 
+at group level.
+
+Instance-level member roles
+===========================
+
+This endpoint requires admin access.
+
+Reference
+---------
+
+* v4 API
+
+  + :class:`gitlab.v4.objects.MemberRole`
+  + :class:`gitlab.v4.objects.MemberRoleManager`
+  + :attr:`gitlab.Gitlab.member_roles`
+
+* GitLab API
+
+  + https://docs.gitlab.com/ee/api/member_roles.html#manage-instance-member-roles
+
+Examples
+--------
+
+List member roles::
+
+    variables = gl.member_roles.list()
+
+Create a member role::
+
+    variable = gl.member_roles.create({'name': 'Custom Role', 'base_access_level': value})
+
+Remove a member role::
+
+    gl.member_roles.delete(member_role_id)
+
+Group member role
+=================
+
+Reference
+---------
+
+* v4 API
+
+  + :class:`gitlab.v4.objects.GroupMemberRole`
+  + :class:`gitlab.v4.objects.GroupMemberRoleManager`
+  + :attr:`gitlab.v4.objects.Group.member_roles`
+
+* GitLab API
+
+  + https://docs.gitlab.com/ee/api/member_roles.html#manage-group-member-roles
+
+Examples
+--------
+
+List member roles::
+
+    member_roles = group.member_roles.list()
+
+Create a member role::
+
+    member_roles = group.member_roles.create({'name': 'Custom Role', 'base_access_level': value})
+
+Remove a member role::
+
+    gl.member_roles.delete(member_role_id)
+
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -166,6 +166,8 @@ def __init__(
         """See :class:`~gitlab.v4.objects.LicenseManager`"""
         self.namespaces = objects.NamespaceManager(self)
         """See :class:`~gitlab.v4.objects.NamespaceManager`"""
+        self.member_roles = objects.MemberRoleManager(self)
+        """See :class:`~gitlab.v4.objects.MergeRequestManager`"""
         self.mergerequests = objects.MergeRequestManager(self)
         """See :class:`~gitlab.v4.objects.MergeRequestManager`"""
         self.notificationsettings = objects.NotificationSettingsManager(self)
diff --git a/gitlab/v4/objects/__init__.py b/gitlab/v4/objects/__init__.py
@@ -39,6 +39,7 @@
 from .keys import *
 from .labels import *
 from .ldap import *
+from .member_roles import *
 from .members import *
 from .merge_request_approvals import *
 from .merge_requests import *
diff --git a/gitlab/v4/objects/groups.py b/gitlab/v4/objects/groups.py
@@ -36,6 +36,7 @@
 from .issues import GroupIssueManager  # noqa: F401
 from .iterations import GroupIterationManager  # noqa: F401
 from .labels import GroupLabelManager  # noqa: F401
+from .member_roles import GroupMemberRoleManager  # noqa: F401
 from .members import (  # noqa: F401
     GroupBillableMemberManager,
     GroupMemberAllManager,
@@ -92,6 +93,7 @@ class Group(SaveMixin, ObjectDeleteMixin, RESTObject):
     iterations: GroupIterationManager
     labels: GroupLabelManager
     ldap_group_links: GroupLDAPGroupLinkManager
+    member_roles: GroupMemberRoleManager
     members: GroupMemberManager
     members_all: GroupMemberAllManager
     mergerequests: GroupMergeRequestManager
diff --git a/gitlab/v4/objects/member_roles.py b/gitlab/v4/objects/member_roles.py
@@ -0,0 +1,102 @@
+"""
+GitLab API:
+https://docs.gitlab.com/ee/api/instance_level_ci_variables.html
+https://docs.gitlab.com/ee/api/project_level_variables.html
+https://docs.gitlab.com/ee/api/group_level_variables.html
+"""
+
+from gitlab.base import RESTObject
+from gitlab.mixins import (
+    CreateMixin,
+    DeleteMixin,
+    ListMixin,
+    ObjectDeleteMixin,
+    SaveMixin,
+)
+from gitlab.types import RequiredOptional
+
+__all__ = [
+    "MemberRole",
+    "MemberRoleManager",
+    "GroupMemberRole",
+    "GroupMemberRoleManager",
+]
+
+
+class MemberRole(SaveMixin, ObjectDeleteMixin, RESTObject):
+    pass
+
+
+class MemberRoleManager(
+    ListMixin[MemberRole], CreateMixin[MemberRole], DeleteMixin[MemberRole]
+):
+    _path = "/member_roles"
+    _obj_cls = MemberRole
+    _create_attrs = RequiredOptional(
+        required=("name", "base_access_level"),
+        optional=(
+            "description",
+            "admin_cicd_variables",
+            "admin_compliance_framework",
+            "admin_group_member",
+            "admin_group_member",
+            "admin_merge_request",
+            "admin_push_rules",
+            "admin_terraform_state",
+            "admin_vulnerability",
+            "admin_web_hook",
+            "archive_project",
+            "manage_deploy_tokens",
+            "manage_group_access_tokens",
+            "manage_merge_request_settings",
+            "manage_project_access_tokens",
+            "manage_security_policy_link",
+            "read_code",
+            "read_runners",
+            "read_dependency",
+            "read_vulnerability",
+            "remove_group",
+            "remove_project",
+        ),
+    )
+
+
+class GroupMemberRole(SaveMixin, ObjectDeleteMixin, RESTObject):
+    pass
+
+
+class GroupMemberRoleManager(
+    ListMixin[GroupMemberRole],
+    CreateMixin[GroupMemberRole],
+    DeleteMixin[GroupMemberRole],
+):
+    _path = "/groups/{group_id}/member_roles"
+    _from_parent_attrs = {"group_id": "id"}
+    _obj_cls = GroupMemberRole
+    _create_attrs = RequiredOptional(
+        required=("name", "base_access_level"),
+        optional=(
+            "description",
+            "admin_cicd_variables",
+            "admin_compliance_framework",
+            "admin_group_member",
+            "admin_group_member",
+            "admin_merge_request",
+            "admin_push_rules",
+            "admin_terraform_state",
+            "admin_vulnerability",
+            "admin_web_hook",
+            "archive_project",
+            "manage_deploy_tokens",
+            "manage_group_access_tokens",
+            "manage_merge_request_settings",
+            "manage_project_access_tokens",
+            "manage_security_policy_link",
+            "read_code",
+            "read_runners",
+            "read_dependency",
+            "read_vulnerability",
+            "remove_group",
+            "remove_project",
+        ),
+    )
diff --git a/tests/functional/api/test_member_roles.py b/tests/functional/api/test_member_roles.py
@@ -0,0 +1,18 @@
+"""
+GitLab API:
+https://docs.gitlab.com/ee/api/member_roles.html
+"""
+
+
+def test_instance_member_role(gl):
+    member_role = gl.member_roles.create(
+        {
+            "name": "Custom webhook manager role",
+            "base_access_level": 20,
+            "description": "Custom reporter that can manage webhooks",
+            "admin_web_hook": True,
+        }
+    )
+    assert member_role.id > 0
+    assert member_role in gl.member_roles.list()
+    gl.member_roles.delete(member_role.id)
diff --git a/tests/unit/objects/test_member_roles.py b/tests/unit/objects/test_member_roles.py
