File: member_roles.rst

package info (click to toggle)
python-gitlab 1%3A8.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,884 kB
  • sloc: python: 25,823; makefile: 171; ruby: 27; javascript: 3
file content (71 lines) | stat: -rw-r--r-- 1,320 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
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/api/member_roles#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/api/member_roles#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)