From 8ec59bd18bcacf13c012a34b3e37c2c9167bcc65 Mon Sep 17 00:00:00 2001
From: "Artem V. Navrotskiy" <bozaro@users.noreply.github.com>
Date: Sat, 29 Aug 2015 12:52:21 +0300
Subject: Add API method for get user by ID of an SSH key

---
 doc/api/users.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

(limited to 'doc')

diff --git a/doc/api/users.md b/doc/api/users.md
index 7ba2db248ff..eb6726b60d3 100644
--- a/doc/api/users.md
+++ b/doc/api/users.md
@@ -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\u0026d=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
 
 Creates a new user. Note only administrators can create new users.
-- 
cgit v1.2.3