グループとプロジェクトのアクセスリクエストAPI

プラン: Free、Premium、Ultimate
提供形態: GitLab.com、GitLab Self-Managed、GitLab Dedicated

このAPIを使用して、グループとプロジェクトのアクセスリクエストを操作します。

有効なアクセスレベル

アクセスレベルはGitlab::Accessモジュールで定義されており、次のレベルが認識されます:

アクセスなし（0）
最小アクセス（5）
ゲスト（10）
プランナー（15）
レポーター（20）
デベロッパー（30）
メンテナー（40）
オーナー（50）

グループまたはプロジェクトのアクセスリクエストをリスト表示

認証済みユーザーが表示できるアクセスリクエストのリストを取得します。

GET /groups/:id/access_requests
GET /projects/:id/access_requests

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス

リクエスト例:

curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/:id/access_requests"
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/:id/access_requests"

レスポンス例:

[
 {
   "id": 1,
   "username": "raymond_smith",
   "name": "Raymond Smith",
   "state": "active",
   "locked": false,
   "avatar_url": "https://gitlab.com/uploads/-/system/user/avatar/1/avatar.png",
   "web_url": "https://gitlab.com/raymond_smith",
   "requested_at": "2024-10-22T14:13:35Z"
 },
 {
   "id": 2,
   "username": "john_doe",
   "name": "John Doe",
   "state": "active",
   "locked": false,
   "avatar_url": "https://gitlab.com/uploads/-/system/user/avatar/2/avatar.png",
   "web_url": "https://gitlab.com/john_doe",
   "requested_at": "2024-10-22T14:13:35Z"
 }
]

グループまたはプロジェクトへのアクセスをリクエスト

認証済みユーザーに、グループまたはプロジェクトへのアクセスをリクエストします。

POST /groups/:id/access_requests
POST /projects/:id/access_requests

属性	型	必須	説明
`id`	整数または文字列	はい	ID、またはグループまたはプロジェクトのURLエンコードされたパス

リクエスト例:

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>"  \
  --url "https://gitlab.example.com/api/v4/groups/:id/access_requests"
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>"  \
  --url "https://gitlab.example.com/api/v4/projects/:id/access_requests"

レスポンス例:

{
  "id": 1,
  "username": "raymond_smith",
  "name": "Raymond Smith",
  "state": "active",
  "created_at": "2012-10-22T14:13:35Z",
  "requested_at": "2012-10-22T14:13:35Z"
}

アクセスリクエストを承認

指定されたユーザーのアクセスリクエストを承認します。

PUT /groups/:id/access_requests/:user_id/approve
PUT /projects/:id/access_requests/:user_id/approve

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス
`user_id`	整数	はい	アクセスリクエスタのユーザーID
`access_level`	整数	いいえ	有効なアクセスレベル（デフォルト: `30`、デベロッパーロール）

リクエスト例:

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>"  \
  --url "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>"  \
  --url "https://gitlab.example.com/api/v4/projects/:id/access_requests/:user_id/approve?access_level=20"

レスポンス例:

{
  "id": 1,
  "username": "raymond_smith",
  "name": "Raymond Smith",
  "state": "active",
  "created_at": "2012-10-22T14:13:35Z",
  "access_level": 20
}

アクセスリクエストを拒否

指定されたユーザーのアクセスリクエストを拒否します。

DELETE /groups/:id/access_requests/:user_id
DELETE /projects/:id/access_requests/:user_id

属性	型	必須	説明
`id`	整数または文字列	はい	プロジェクトのIDまたはURLエンコードされたパス
`user_id`	整数	はい	アクセスリクエスタのユーザーID

リクエスト例:

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>"  \
  --url "https://gitlab.example.com/api/v4/groups/:id/access_requests/:user_id"
curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/:id/access_requests/:user_id"