debian-mirror-gitlab/doc/api/access_requests.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

153 lines
5 KiB
Markdown
Raw Normal View History

2020-10-24 23:57:45 +05:30
---
2021-02-22 17:27:13 +05:30
stage: Manage
2022-04-04 11:22:00 +05:30
group: Authentication and Authorization
2021-02-22 17:27:13 +05:30
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments"
2020-10-24 23:57:45 +05:30
---
2021-11-11 11:23:49 +05:30
# Group and project access requests API **(FREE)**
2016-09-13 17:45:13 +05:30
2020-03-13 15:44:24 +05:30
## Valid access levels
2016-09-13 17:45:13 +05:30
2021-02-22 17:27:13 +05:30
The access levels are defined in the `Gitlab::Access` module, and the
following levels are recognized:
2016-09-13 17:45:13 +05:30
2020-06-23 00:09:42 +05:30
- No access (`0`)
2021-02-22 17:27:13 +05:30
- Minimal access (`5`) ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/220203) in GitLab 13.5.)
2020-06-23 00:09:42 +05:30
- Guest (`10`)
- Reporter (`20`)
- Developer (`30`)
- Maintainer (`40`)
- Owner (`50`) - Only valid to set for groups
2016-09-13 17:45:13 +05:30
## List access requests for a group or project
Gets a list of access requests viewable by the authenticated user.
2019-12-21 20:55:43 +05:30
```plaintext
2016-09-13 17:45:13 +05:30
GET /groups/:id/access_requests
GET /projects/:id/access_requests
```
2019-12-21 20:55:43 +05:30
| Attribute | Type | Required | Description |
| --------- | -------------- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2019-12-21 20:55:43 +05:30
Example request:
2016-09-13 17:45:13 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/access_requests"
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/access_requests"
2016-09-13 17:45:13 +05:30
```
Example response:
```json
[
{
"id": 1,
"username": "raymond_smith",
"name": "Raymond Smith",
"state": "active",
"created_at": "2012-10-22T14:13:35Z",
"requested_at": "2012-10-22T14:13:35Z"
},
{
"id": 2,
"username": "john_doe",
"name": "John Doe",
"state": "active",
"created_at": "2012-10-22T14:13:35Z",
"requested_at": "2012-10-22T14:13:35Z"
}
]
```
## Request access to a group or project
Requests access for the authenticated user to a group or project.
2019-12-21 20:55:43 +05:30
```plaintext
2016-09-13 17:45:13 +05:30
POST /groups/:id/access_requests
POST /projects/:id/access_requests
```
2022-07-23 23:45:48 +05:30
| Attribute | Type | Required | Description |
| --------- | -------------- | -------- |-----------------------------------------------------------------------------------------|
| `id` | integer/string | yes | The ID or [URL-encoded path of the group or project](index.md#namespaced-path-encoding) |
2019-12-21 20:55:43 +05:30
Example request:
2016-09-13 17:45:13 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/access_requests"
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/access_requests"
2016-09-13 17:45:13 +05:30
```
Example response:
```json
{
"id": 1,
"username": "raymond_smith",
"name": "Raymond Smith",
"state": "active",
"created_at": "2012-10-22T14:13:35Z",
"requested_at": "2012-10-22T14:13:35Z"
}
```
## Approve an access request
Approves an access request for the given user.
2019-12-21 20:55:43 +05:30
```plaintext
2016-09-13 17:45:13 +05:30
PUT /groups/:id/access_requests/:user_id/approve
PUT /projects/:id/access_requests/:user_id/approve
```
2019-12-21 20:55:43 +05:30
| Attribute | Type | Required | Description |
| -------------- | -------------- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2019-12-21 20:55:43 +05:30
| `user_id` | integer | yes | The user ID of the access requester |
2021-09-30 23:02:18 +05:30
| `access_level` | integer | no | A valid access level (defaults: `30`, the Developer role) |
2019-12-21 20:55:43 +05:30
Example request:
2016-09-13 17:45:13 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/access_requests/:user_id/approve?access_level=20"
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/access_requests/:user_id/approve?access_level=20"
2016-09-13 17:45:13 +05:30
```
Example response:
```json
{
"id": 1,
"username": "raymond_smith",
"name": "Raymond Smith",
"state": "active",
"created_at": "2012-10-22T14:13:35Z",
"access_level": 20
}
```
## Deny an access request
Denies an access request for the given user.
2019-12-21 20:55:43 +05:30
```plaintext
2016-09-13 17:45:13 +05:30
DELETE /groups/:id/access_requests/:user_id
DELETE /projects/:id/access_requests/:user_id
```
2019-12-21 20:55:43 +05:30
| Attribute | Type | Required | Description |
| --------- | -------------- | -------- | ----------- |
2021-09-30 23:02:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](index.md#namespaced-path-encoding) owned by the authenticated user |
2019-12-21 20:55:43 +05:30
| `user_id` | integer | yes | The user ID of the access requester |
Example request:
2016-09-13 17:45:13 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/access_requests/:user_id"
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/access_requests/:user_id"
2016-09-13 17:45:13 +05:30
```