summaryrefslogtreecommitdiff
path: root/docs/gl_objects/access_requests.rst
blob: f64e79512b2312f74c538b7fd41f21c4d351bce5 (plain)
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
72
###############
Access requests
###############

Users can request access to groups and projects.

When access is granted the user should be given a numerical access level. The
following constants are provided to represent the access levels:

* ``gitlab.GUEST_ACCESS``: ``10``
* ``gitlab.REPORTER_ACCESS``: ``20``
* ``gitlab.DEVELOPER_ACCESS``: ``30``
* ``gitlab.MASTER_ACCESS``: ``40``
* ``gitlab.OWNER_ACCESS``: ``50``

References
----------

* v4 API:

  + :class:`gitlab.v4.objects.ProjectAccessRequest`
  + :class:`gitlab.v4.objects.ProjectAccessRequestManager`
  + :attr:`gitlab.v4.objects.Project.accessrequests`
  + :class:`gitlab.v4.objects.GroupAccessRequest`
  + :class:`gitlab.v4.objects.GroupAccessRequestManager`
  + :attr:`gitlab.v4.objects.Group.accessrequests`

* v3 API:

  + :class:`gitlab.v3.objects.ProjectAccessRequest`
  + :class:`gitlab.v3.objects.ProjectAccessRequestManager`
  + :attr:`gitlab.v3.objects.Project.accessrequests`
  + :attr:`gitlab.Gitlab.project_accessrequests`
  + :class:`gitlab.v3.objects.GroupAccessRequest`
  + :class:`gitlab.v3.objects.GroupAccessRequestManager`
  + :attr:`gitlab.v3.objects.Group.accessrequests`
  + :attr:`gitlab.Gitlab.group_accessrequests`

* GitLab API: https://docs.gitlab.com/ce/api/access_requests.html

Examples
--------

List access requests from projects and groups:

.. literalinclude:: access_requests.py
   :start-after: # list
   :end-before: # end list

Get a single request:

.. literalinclude:: access_requests.py
   :start-after: # get
   :end-before: # end get

Create an access request:

.. literalinclude:: access_requests.py
   :start-after: # create
   :end-before: # end create

Approve an access request:

.. literalinclude:: access_requests.py
   :start-after: # approve
   :end-before: # end approve

Deny (delete) an access request:

.. literalinclude:: access_requests.py
   :start-after: # delete
   :end-before: # end delete