機能フラグユーザーリストAPI

GitLab機能フラグユーザーリストにアクセスするためのAPI。

少なくとも Developerロールを持つユーザーは、機能フラグユーザーリスト API にアクセスできます。

note
GET API の結果はページ分割されているため、リクエストは一度に 20 件の結果を返します。この値は変更可能です。

プロジェクトの全機能フラグユーザーリストの一覧表示

指定したプロジェクトのすべての機能フラグユーザーリストを取得します。

GET /projects/:id/feature_flags_user_lists
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
search文字列です。いいえ検索条件に一致するユーザーリストを返します。
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/feature_flags_user_lists"

応答例

[
   {
      "name": "user_list",
      "user_xids": "user1,user2",
      "id": 1,
      "iid": 1,
      "project_id": 1,
      "created_at": "2020-02-04T08:13:51.423Z",
      "updated_at": "2020-02-04T08:13:51.423Z"
   },
   {
      "name": "test_users",
      "user_xids": "user3,user4,user5",
      "id": 2,
      "iid": 2,
      "project_id": 1,
      "created_at": "2020-02-04T08:13:10.507Z",
      "updated_at": "2020-02-04T08:13:10.507Z"
   }
]

機能フラグユーザーリストの作成

機能フラグユーザーリストを作成します。

POST /projects/:id/feature_flags_user_lists
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
name文字列です。yesリストの名前。
user_xids文字列です。yes外部ユーザーIDのカンマ区切りリスト。
curl "https://gitlab.example.com/api/v4/projects/1/feature_flags_user_lists" \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-type: application/json" \
     --data @- << EOF
{
    "name": "my_user_list",
    "user_xids": "user1,user2,user3"
}
EOF

応答例

{
   "name": "my_user_list",
   "user_xids": "user1,user2,user3",
   "id": 1,
   "iid": 1,
   "project_id": 1,
   "created_at": "2020-02-04T08:32:27.288Z",
   "updated_at": "2020-02-04T08:32:27.288Z"
}

機能フラグユーザーリストの取得

機能フラグユーザーリストを取得します。

GET /projects/:id/feature_flags_user_lists/:iid
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
iid整数/文字列yesプロジェクトの機能フラグユーザーリストの内部ID。
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/feature_flags_user_lists/1"

応答例

{
   "name": "my_user_list",
   "user_xids": "123,456",
   "id": 1,
   "iid": 1,
   "project_id": 1,
   "created_at": "2020-02-04T08:13:10.507Z",
   "updated_at": "2020-02-04T08:13:10.507Z"
}

機能フラグユーザーリストの更新

機能フラグユーザーリストを更新します。

PUT /projects/:id/feature_flags_user_lists/:iid
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
iid整数/文字列yesプロジェクトの機能フラグユーザーリストの内部ID。
name文字列です。いいえリストの名前。
user_xids文字列です。いいえ外部ユーザーIDのカンマ区切りリスト。
curl "https://gitlab.example.com/api/v4/projects/1/feature_flags_user_lists/1" \
     --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-type: application/json" \
     --request PUT \
     --data @- << EOF
{
    "user_xids": "user2,user3,user4"
}
EOF

応答例

{
   "name": "my_user_list",
   "user_xids": "user2,user3,user4",
   "id": 1,
   "iid": 1,
   "project_id": 1,
   "created_at": "2020-02-04T08:32:27.288Z",
   "updated_at": "2020-02-05T09:33:17.179Z"
}

機能フラグユーザーリストの削除

機能フラグユーザーリストを削除します。

DELETE /projects/:id/feature_flags_user_lists/:iid
属性種類必須説明
id整数/文字列yes プロジェクトのIDまたはURLエンコードされたパス。
iid整数/文字列yesプロジェクトの機能フラグユーザーリストの内部ID
curl --header "PRIVATE-TOKEN: <your_access_token>" --request DELETE "https://gitlab.example.com/api/v4/projects/1/feature_flags_user_lists/1"