Merge branch '29903-remove-user-is-admin-flag-from-api' into 'master'

changelogs/unreleased/29903-remove-user-is-admin-flag-from-api.yml

+---
+title: Don't display the is_admin flag in most API responses
+merge_request: 10846
+author:

doc/api/deployments.md

@@ -48,7 +48,6 @@ Example of response
         "bio": null,
         "created_at": "2016-08-11T07:09:20.351Z",
         "id": 1,
-        "is_admin": true,
         "linkedin": "",
         "location": null,
         "name": "Administrator",
@@ -106,7 +105,6 @@ Example of response
         "bio": null,
         "created_at": "2016-08-11T07:09:20.351Z",
         "id": 1,
-        "is_admin": true,
         "linkedin": "",
         "location": null,
         "name": "Administrator",
@@ -195,7 +193,6 @@ Example of response
       "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
       "web_url": "http://localhost:3000/root",
       "created_at": "2016-08-11T07:09:20.351Z",
-      "is_admin": true,
       "bio": null,
       "location": null,
       "skype": "",

doc/api/jobs.md

@@ -57,7 +57,6 @@ Example of response
       "bio": null,
       "created_at": "2015-12-21T13:14:24.077Z",
       "id": 1,
-      "is_admin": true,
       "linkedin": "",
       "name": "Administrator",
       "skype": "",
@@ -101,7 +100,6 @@ Example of response
       "bio": null,
       "created_at": "2015-12-21T13:14:24.077Z",
       "id": 1,
-      "is_admin": true,
       "linkedin": "",
       "name": "Administrator",
       "skype": "",
@@ -173,7 +171,6 @@ Example of response
       "bio": null,
       "created_at": "2015-12-21T13:14:24.077Z",
       "id": 1,
-      "is_admin": true,
       "linkedin": "",
       "name": "Administrator",
       "skype": "",
@@ -217,7 +214,6 @@ Example of response
       "bio": null,
       "created_at": "2015-12-21T13:14:24.077Z",
       "id": 1,
-      "is_admin": true,
       "linkedin": "",
       "name": "Administrator",
       "skype": "",
@@ -284,7 +280,6 @@ Example of response
     "bio": null,
     "created_at": "2015-12-21T13:14:24.077Z",
     "id": 1,
-    "is_admin": true,
     "linkedin": "",
     "name": "Administrator",
     "skype": "",

doc/api/keys.md

@@ -26,7 +26,6 @@ Parameters:
     "avatar_url": "http://www.gravatar.com/avatar/cfa35b8cd2ec278026357769582fa563?s=40\u0026d=identicon",
     "web_url": "http://localhost:3000/john_smith",
     "created_at": "2015-09-03T07:24:01.670Z",
-    "is_admin": false,
     "bio": null,
     "skype": "",
     "linkedin": "",

doc/api/users.md

@@ -62,7 +62,6 @@ GET /users
     "avatar_url": "http://localhost:3000/uploads/user/avatar/1/index.jpg",
     "web_url": "http://localhost:3000/john_smith",
     "created_at": "2012-05-23T08:00:58Z",
-    "is_admin": false,
     "bio": null,
     "location": null,
     "skype": "",
@@ -95,7 +94,6 @@ GET /users
     "avatar_url": "http://localhost:3000/uploads/user/avatar/2/index.jpg",
     "web_url": "http://localhost:3000/jack_smith",
     "created_at": "2012-05-23T08:01:01Z",
-    "is_admin": false,
     "bio": null,
     "location": null,
     "skype": "",
@@ -169,7 +167,6 @@ Parameters:
   "avatar_url": "http://localhost:3000/uploads/user/avatar/1/cd8.jpeg",
   "web_url": "http://localhost:3000/john_smith",
   "created_at": "2012-05-23T08:00:58Z",
-  "is_admin": false,
   "bio": null,
   "location": null,
   "skype": "",
@@ -200,7 +197,6 @@ Parameters:
   "avatar_url": "http://localhost:3000/uploads/user/avatar/1/index.jpg",
   "web_url": "http://localhost:3000/john_smith",
   "created_at": "2012-05-23T08:00:58Z",
-  "is_admin": false,
   "bio": null,
   "location": null,
   "skype": "",
@@ -325,7 +321,6 @@ GET /user
   "avatar_url": "http://localhost:3000/uploads/user/avatar/1/index.jpg",
   "web_url": "http://localhost:3000/john_smith",
   "created_at": "2012-05-23T08:00:58Z",
-  "is_admin": false,
   "bio": null,
   "location": null,
   "skype": "",

lib/api/entities.rb

@@ -14,7 +14,6 @@ module API
 
     class User < UserBasic
       expose :created_at
-      expose :admin?, as: :is_admin
       expose :bio, :location, :skype, :linkedin, :twitter, :website_url, :organization
     end
 
@@ -41,8 +40,9 @@ module API
       expose :external
     end
 
-    class UserWithPrivateToken < UserPublic
+    class UserWithPrivateDetails < UserPublic
       expose :private_token
+      expose :admin?, as: :is_admin
     end
 
     class Email < Grape::Entity

lib/api/session.rb

 module API
   class Session < Grape::API
     desc 'Login to get token' do
-      success Entities::UserWithPrivateToken
+      success Entities::UserWithPrivateDetails
     end
     params do
       optional :login, type: String, desc: 'The username'
@@ -14,7 +14,7 @@ module API
 
       return unauthorized! unless user
       return render_api_error!('401 Unauthorized. You have 2FA enabled. Please use a personal access token to access the API', 401) if user.two_factor_enabled?
-      present user, with: Entities::UserWithPrivateToken
+      present user, with: Entities::UserWithPrivateDetails
     end
   end
 end

lib/api/users.rb

@@ -433,7 +433,7 @@ module API
         success Entities::UserPublic
       end
       get do
-        present current_user, with: sudo? ? Entities::UserWithPrivateToken : Entities::UserPublic
+        present current_user, with: sudo? ? Entities::UserWithPrivateDetails : Entities::UserPublic
       end
 
       desc "Get the currently authenticated user's SSH keys" do

spec/fixtures/api/schemas/public_api/v4/user/public.json

@@ -9,7 +9,6 @@
     "avatar_url",
     "web_url",
     "created_at",
-    "is_admin",
     "bio",
     "location",
     "skype",
@@ -43,7 +42,6 @@
     "avatar_url": { "type": "string" },
     "web_url": { "type": "string" },
     "created_at": { "type": "date" },
-    "is_admin": { "type": "boolean" },
     "bio": { "type": ["string", "null"] },
     "location": { "type": ["string", "null"] },
     "skype": { "type": "string" },

spec/requests/api/keys_spec.rb

@@ -32,6 +32,12 @@ describe API::Keys do
         expect(json_response['user']['id']).to eq(user.id)
         expect(json_response['user']['username']).to eq(user.username)
       end
+
+      it "does not include the user's `is_admin` flag" do
+        get api("/keys/#{key.id}", admin)
+
+        expect(json_response['user']['is_admin']).to be_nil
+      end
     end
   end
 end

spec/requests/api/users_spec.rb

@@ -135,6 +135,12 @@ describe API::Users do
       expect(json_response['username']).to eq(user.username)
     end
 
+    it "does not return the user's `is_admin` flag" do
+      get api("/users/#{user.id}", user)
+
+      expect(json_response['is_admin']).to be_nil
+    end
+
     it "returns a 401 if unauthenticated" do
       get api("/users/9998")
       expect(response).to have_http_status(401)
@@ -397,7 +403,6 @@ describe API::Users do
     it "updates admin status" do
       put api("/users/#{user.id}", admin), { admin: true }
       expect(response).to have_http_status(200)
-      expect(json_response['is_admin']).to eq(true)
       expect(user.reload.admin).to eq(true)
     end
 
@@ -411,7 +416,6 @@ describe API::Users do
     it "does not update admin status" do
       put api("/users/#{admin_user.id}", admin), { can_create_group: false }
       expect(response).to have_http_status(200)
-      expect(json_response['is_admin']).to eq(true)
       expect(admin_user.reload.admin).to eq(true)
       expect(admin_user.can_create_group).to eq(false)
     end

spec/requests/api/v3/users_spec.rb

@@ -274,5 +274,11 @@ describe API::V3::Users do
 
       expect(new_user).to be_confirmed
     end
+
+    it 'does not reveal the `is_admin` flag of the user' do
+      post v3_api('/users', admin), attributes_for(:user)
+
+      expect(json_response['is_admin']).to be_nil
+    end
   end
 end