summaryrefslogtreecommitdiff
path: root/docs/gl_objects/access_requests.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/gl_objects/access_requests.rst')
-rw-r--r--docs/gl_objects/access_requests.rst53
1 files changed, 0 insertions, 53 deletions
diff --git a/docs/gl_objects/access_requests.rst b/docs/gl_objects/access_requests.rst
deleted file mode 100644
index 467c3e5..0000000
--- a/docs/gl_objects/access_requests.rst
+++ /dev/null
@@ -1,53 +0,0 @@
-###############
-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.MAINTAINER_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`
-
-* GitLab API: https://docs.gitlab.com/ce/api/access_requests.html
-
-Examples
---------
-
-List access requests from projects and groups::
-
- p_ars = project.accessrequests.list()
- g_ars = group.accessrequests.list()
-
-Create an access request::
-
- p_ar = project.accessrequests.create()
- g_ar = group.accessrequests.create()
-
-Approve an access request::
-
- ar.approve() # defaults to DEVELOPER level
- ar.approve(access_level=gitlab.MAINTAINER_ACCESS) # explicitly set access level
-
-Deny (delete) an access request::
-
- project.accessrequests.delete(user_id)
- group.accessrequests.delete(user_id)
- # or
- ar.delete()