Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Tatuya Kamada
gitlab-ce
Commits
8ec59bd1
Commit
8ec59bd1
authored
Aug 29, 2015
by
Artem V. Navrotskiy
Committed by
Artem V. Navrotskiy
Sep 03, 2015
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add API method for get user by ID of an SSH key
parent
ff8fb6a6
Changes
6
Hide whitespace changes
Inline
Side-by-side
Showing
6 changed files
with
110 additions
and
0 deletions
+110
-0
CHANGELOG
CHANGELOG
+1
-0
doc/api/users.md
doc/api/users.md
+45
-0
lib/api/api.rb
lib/api/api.rb
+1
-0
lib/api/entities.rb
lib/api/entities.rb
+4
-0
lib/api/keys.rb
lib/api/keys.rb
+20
-0
spec/requests/api/keys_spec.rb
spec/requests/api/keys_spec.rb
+39
-0
No files found.
CHANGELOG
View file @
8ec59bd1
...
@@ -35,6 +35,7 @@ v 8.0.0 (unreleased)
...
@@ -35,6 +35,7 @@ v 8.0.0 (unreleased)
- Added Drone CI integration (Kirill Zaitsev)
- Added Drone CI integration (Kirill Zaitsev)
- Refactored service API and added automatically service docs generator (Kirill Zaitsev)
- Refactored service API and added automatically service docs generator (Kirill Zaitsev)
- Added web_url key project hook_attrs (Kirill Zaitsev)
- Added web_url key project hook_attrs (Kirill Zaitsev)
- Add ability to get user information by ID of an SSH key via the API
v 7.14.1
v 7.14.1
- Improve abuse reports management from admin area
- Improve abuse reports management from admin area
...
...
doc/api/users.md
View file @
8ec59bd1
...
@@ -150,6 +150,51 @@ Parameters:
...
@@ -150,6 +150,51 @@ Parameters:
}
}
```
```
### Get SSH key with user by ID of an SSH key
Get SSH key with user by ID of an SSH key. Note only administrators can lookup SSH key with user by ID of an SSH key.
```
GET /keys/:id
```
Parameters:
-
`id`
(required) - The ID of an SSH key
```
json
{
"id"
:
1
,
"title"
:
"Sample key 25"
,
"key"
:
"ssh-rsa AAAAB3NzaC1yc2EAAAABJQAAAIEAiPWx6WM4lhHNedGfBpPJNPpZ7yKu+dnn1SJejgt1256k6YjzGGphH2TUxwKzxcKDKKezwkpfnxPkSMkuEspGRt/aZZ9wa++Oi7Qkr8prgHc4soW6NUlfDzpvZK2H5E7eQaSeP3SAwGmQKUFHCddNaP0L+hM7zhFNzjFvpaMgJw0="
,
"created_at"
:
"2015-09-03T07:24:44.627Z"
,
"user"
:
{
"name"
:
"John Smith"
,
"username"
:
"john_smith"
,
"id"
:
25
,
"state"
:
"active"
,
"avatar_url"
:
"http://www.gravatar.com/avatar/cfa35b8cd2ec278026357769582fa563?s=40
\u
0026d=identicon"
,
"web_url"
:
"http://localhost:3000/u/john_smith"
,
"created_at"
:
"2015-09-03T07:24:01.670Z"
,
"is_admin"
:
false
,
"bio"
:
null
,
"skype"
:
""
,
"linkedin"
:
""
,
"twitter"
:
""
,
"website_url"
:
""
,
"email"
:
"john@example.com"
,
"theme_id"
:
2
,
"color_scheme_id"
:
1
,
"projects_limit"
:
10
,
"current_sign_in_at"
:
null
,
"identities"
:
[],
"can_create_group"
:
true
,
"can_create_project"
:
true
,
"two_factor_enabled"
:
false
}
}
```
## User creation
## User creation
Creates a new user. Note only administrators can create new users.
Creates a new user. Note only administrators can create new users.
...
...
lib/api/api.rb
View file @
8ec59bd1
...
@@ -50,5 +50,6 @@ module API
...
@@ -50,5 +50,6 @@ module API
mount
Branches
mount
Branches
mount
Labels
mount
Labels
mount
Settings
mount
Settings
mount
Keys
end
end
end
end
lib/api/entities.rb
View file @
8ec59bd1
...
@@ -199,6 +199,10 @@ module API
...
@@ -199,6 +199,10 @@ module API
expose
:id
,
:title
,
:key
,
:created_at
expose
:id
,
:title
,
:key
,
:created_at
end
end
class
SSHKeyWithUser
<
SSHKey
expose
:user
,
using:
Entities
::
UserFull
end
class
Note
<
Grape
::
Entity
class
Note
<
Grape
::
Entity
expose
:id
expose
:id
expose
:note
,
as: :body
expose
:note
,
as: :body
...
...
lib/api/keys.rb
0 → 100644
View file @
8ec59bd1
module
API
# Keys API
class
Keys
<
Grape
::
API
before
{
authenticate!
}
resource
:keys
do
# Get single ssh key by id. Only available to admin users.
#
# Example Request:
# GET /keys/:id
get
":id"
do
authenticated_as_admin!
key
=
Key
.
find
(
params
[
:id
])
present
key
,
with:
Entities
::
SSHKeyWithUser
end
end
end
end
spec/requests/api/keys_spec.rb
0 → 100644
View file @
8ec59bd1
require
'spec_helper'
describe
API
::
API
,
api:
true
do
include
ApiHelpers
let
(
:user
)
{
create
(
:user
)
}
let
(
:admin
)
{
create
(
:admin
)
}
let
(
:key
)
{
create
(
:key
,
user:
user
)
}
let
(
:email
)
{
create
(
:email
,
user:
user
)
}
describe
'GET /keys/:uid'
do
before
{
admin
}
context
'when unauthenticated'
do
it
'should return authentication error'
do
get
api
(
"/keys/
#{
key
.
id
}
"
)
expect
(
response
.
status
).
to
eq
(
401
)
end
end
context
'when authenticated'
do
it
'should return 404 for non-existing key'
do
get
api
(
'/keys/999999'
,
admin
)
expect
(
response
.
status
).
to
eq
(
404
)
expect
(
json_response
[
'message'
]).
to
eq
(
'404 Not found'
)
end
it
'should return single ssh key with user information'
do
user
.
keys
<<
key
user
.
save
get
api
(
"/keys/
#{
key
.
id
}
"
,
admin
)
expect
(
response
.
status
).
to
eq
(
200
)
expect
(
json_response
[
'title'
]).
to
eq
(
key
.
title
)
expect
(
json_response
[
'user'
][
'id'
]).
to
eq
(
user
.
id
)
expect
(
json_response
[
'user'
][
'username'
]).
to
eq
(
user
.
username
)
end
end
end
end
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment