<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags --> <title>drip-api: KeyPairController</title> <!-- Mobile viewport optimized: j.mp/bplateviewport --> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <!-- Bootstrap core CSS --> <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css"> <!--custom css for these pages--> <link rel="stylesheet" href="css/style.css"> <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script> <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> <![endif]--> </head> <body data-spy="scroll" data-target="#apinav"> <nav class="navbar navbar-inverse navbar-fixed-top"> <div class="container-fluid"> <div class="navbar-header"> <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a class="navbar-brand" href="index.html">drip-api: KeyPairController</a> </div> <div id="navbar" class="navbar-collapse collapse"> <ul class="nav navbar-nav navbar-right"> <li><a href="resources.html">Resources</a></li> <li><a href="data.html">Data Types</a></li> <li><a href="downloads.html">Files and Libraries</a></li> </ul> </div> </div> </nav> <div class="container-fluid"> <div class="row"> <div class="col-sm-3 col-md-2 sidebar" id="apinav"> <ul class="nav nav-sidebar"> <li><a href="#resource_KeyPairController_postKeyPair_POST">POST /user/v1.0/keys/</a></li> <li><a href="#resource_KeyPairController_deleteAll_DELETE">DELETE /user/v1.0/keys/all</a></li> <li><a href="#resource_KeyPairController_getIds_GET">GET /user/v1.0/keys/ids</a></li> <li><a href="#resource_KeyPairController_geta_GET">GET /user/v1.0/keys/sample</a></li> <li><a href="#resource_KeyPairController_delete_DELETE">DELETE /user/v1.0/keys/{id}</a></li> <li><a href="#resource_KeyPairController_get_GET">GET /user/v1.0/keys/{id}</a></li> <li class="divider"></li> <li class="text-right"><a href="#top"><small>Back to Top</small></a></li> </ul> </div> <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main"> <ol class="breadcrumb" id="top"> <li class="active dropdown"><a href="index.html">Home</a></li> <li class="active dropdown"><a href="resources.html">Resources</a></li> <li class="dropdown"><a href="resource_KeyPairController.html">KeyPairController</a></li> </ol> <h1 class="page-header">KeyPairController <small>Resource</small></h1> <p>This controller is responsible for handling user public keys. These keys can be used by the provisoner to allow the user to login to the VMs from the machine the keys correspond to.</p> <div id="resource_KeyPairController_postKeyPair_POST"> <h3><span class="label label-default resource-method">POST</span> <span class="resource-path">/user/v1.0/keys/ <a href="./user/v1.0/keys/" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p>Posts the Key and stores it. The Key is a container for public pair contents. The public pair contents are represented in the 'pair' field. All new lines in the 'pair' field have to be replaced with the '\n' character.</p> <dl class="dl-horizontal"> <dt>Security Roles Allowed</dt> <dd>ADMIN, USER</dd> </dl> <table class="table resource-request-body"> <caption>Request Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/json" HTTP header to specify this media type to the server."><span class="request-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_KeyPair.html">KeyPair</a> (JSON)</span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Content-Type: application/xml" HTTP header to specify this media type to the server."><span class="request-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_keyPair.html">keyPair</a> (XML)</span></td> </tr> </tbody> </table> <table class="table resource-response-codes"> <caption>Response Codes</caption> <thead> <tr> <th>code</th> <th>condition</th> </tr> </thead> <tbody> <tr> <td><span class="label label-warning response-code">400</span></td> <td><span class="response-condition">Key can't be empty</span></td> </tr> <tr> <td><span class="label label-warning response-code">401</span></td> <td><span class="response-condition">Bad credentials</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <caption>Response Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference">string (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description">the ID of the Key</span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference">string (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> POST /user/v1.0/keys/ Content-Type: application/json Accept: application/json <code class="prettyprint language-js"> { "privateKey" : { "name" : "id_dsa.pub", "type" : "PRIVATE", "attributes" : { "property1" : "domain_name:Virginia", "property2" : "domain_name:Virginia" }, "key" : "-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEAm6AALYxkJFNzD3bfVJ4+hMY5j0/kqM9CURLKXMlYuAysnvoG8wZKx9Bedefm\\neNSse4zTg798ZA2kDMZFIrwp1AseTwtj8DDu5fhG5DjyI3g6iJltS5zFQdMXneDlHXBX8cncSzNY\\nRx0NdjEMAe7YttvI8FNlxL0VnMFli/HB/ftzYMe5+AmkSROncVGHiwoiUpj+vtobCFOYtXsCf6ri\\nd4lgWA5wv6DZT/JKCYymiBqgSXu3ueFcEzw5SAukARWVjn1xccjZkokFfBbO/FpYY00TrUTBw9S6\\nD3iM+gj8RT6EKILOmhrt71D21S95WAWIT7h2YBsy1KAvMixhNf9VaQIDAQABAoIBAHhVYK3Xl3tr\\nN1Xm0ctJTQg3ijxhR2qsUBgGUokqezpdOoD2zbbOz7XvTYsX1GLr967U9pwxzUpELexexwiTvDgk\\nnLv8D7ui6qbRsmc4DSsWBRSophVIVFKQmftO8Xow6x+fuYJAYmsicM1KIYHBILtL+PSzV8anenWq\\nKQ3r0tfCiQhEzKEk4b1uT3SJWQyHE++JAhVkO7lIeb6S9Dg1jAaAeMnJ/NiMxTarpPRnxe6hsTsH\\ngG1iKWo+Skcl4SknOc+CMEfyDjG4FL7MGhKduahsO8vMUrgGsDD7EH3NiX/FweB8La6qpDYAwFpC\\nycrooyhiyzw8Wb5gGaYnmvr9l70CgYEAx74O8JleXaHpxEAmh4h7VbLmJ3mOylfBmOdzcHeedJQw\\nack2SAv65WBI9S9MEQ7J/vFuyw5HNk3C/mcWgzDQXSNIhHLvl/Z9sux/Qpm3SQWLzBxKV3dJ4r\\nwcAxzVA93+/L1Nee+VOKnlyRumvVa6+XLsLagpap2AVcTqlerMcCgYEAx3T2pXtqkCE9eU/ov22r\\npdaKjgHoGOUg1CMEfWi/Ch6sYIIRyrHz6dhy+yR1pXNgPbLWdrn8l88F3+IsmbaMupMgRmqwEC3G\\n9Y2FglGIVvRdZaagvRxLzRCcvcN4v6OYs9ST4o1xlv7Qxphld+0XDKv7VSCv/rASuK8BqlFL3E8C\\ngYArMXJRnRjG7qh6g9TRIjZphdI3XxX9s5Rt2D8iZvuhAhqmBZjzY4PR7kxYmO2+EpCjzNnEl0XW\\n/GHaWbiIjhnAykx4N9KP7gGom3O5lzwHUme1XnFKcO2wDjQwJbufRmba8iQF1srN577mF+Z7ha4V\\nJ1duCTzvWF1KFX6sk/uhKQKBgAcDFai7rgNjJ8YcCRKxyFcMM9LKPl6hr4XFtWKzTAQPEABUkkuN\\n9gVClsg9f+VRKRECOIf0Ae1UWeCFEwxUXp4wjfHrzkTDVztKvmbWdvSXorDwKrZ7SC7tZpVFSfly\\nxuuLjadpUZT9YFmbAfY1X5oSccOMYqORjRbxEB3svb4BAoGAGTgFuq9Zojh/KIqY8b4HpEfmh6CQ\\nhLVfD98Nqd6GDbxgvIM0v4mFXE92x2jn35Ia0JdFyh3B8Vkl7sqQZfxDFXI9O9pte2mxY9ICaY\\n55+X/SN1pd53BH+gaPZJy/R+Vpvs5MN48hoUKy5UKpoFeUWrS5QArjtvNCm4SGlXw=\\n-----END RSA PRIVATE KEY-----\\n" }, "publicKey" : { "name" : "id_dsa.pub", "type" : "PRIVATE", "attributes" : { "property1" : "domain_name:Virginia", "property2" : "domain_name:Virginia" }, "key" : "-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEAm6AALYxkJFNzD3bfVJ4+hMY5j0/kqM9CURLKXMlYuAysnvoG8wZKx9Bedefm\\neNSse4zTg798ZA2kDMZFIrwp1AseTwtj8DDu5fhG5DjyI3g6iJltS5zFQdMXneDlHXBX8cncSzNY\\nRx0NdjEMAe7YttvI8FNlxL0VnMFli/HB/ftzYMe5+AmkSROncVGHiwoiUpj+vtobCFOYtXsCf6ri\\nd4lgWA5wv6DZT/JKCYymiBqgSXu3ueFcEzw5SAukARWVjn1xccjZkokFfBbO/FpYY00TrUTBw9S6\\nD3iM+gj8RT6EKILOmhrt71D21S95WAWIT7h2YBsy1KAvMixhNf9VaQIDAQABAoIBAHhVYK3Xl3tr\\nN1Xm0ctJTQg3ijxhR2qsUBgGUokqezpdOoD2zbbOz7XvTYsX1GLr967U9pwxzUpELexexwiTvDgk\\nnLv8D7ui6qbRsmc4DSsWBRSophVIVFKQmftO8Xow6x+fuYJAYmsicM1KIYHBILtL+PSzV8anenWq\\nKQ3r0tfCiQhEzKEk4b1uT3SJWQyHE++JAhVkO7lIeb6S9Dg1jAaAeMnJ/NiMxTarpPRnxe6hsTsH\\ngG1iKWo+Skcl4SknOc+CMEfyDjG4FL7MGhKduahsO8vMUrgGsDD7EH3NiX/FweB8La6qpDYAwFpC\\nycrooyhiyzw8Wb5gGaYnmvr9l70CgYEAx74O8JleXaHpxEAmh4h7VbLmJ3mOylfBmOdzcHeedJQw\\nack2SAv65WBI9S9MEQ7J/vFuyw5HNk3C/mcWgzDQXSNIhHLvl/Z9sux/Qpm3SQWLzBxKV3dJ4r\\nwcAxzVA93+/L1Nee+VOKnlyRumvVa6+XLsLagpap2AVcTqlerMcCgYEAx3T2pXtqkCE9eU/ov22r\\npdaKjgHoGOUg1CMEfWi/Ch6sYIIRyrHz6dhy+yR1pXNgPbLWdrn8l88F3+IsmbaMupMgRmqwEC3G\\n9Y2FglGIVvRdZaagvRxLzRCcvcN4v6OYs9ST4o1xlv7Qxphld+0XDKv7VSCv/rASuK8BqlFL3E8C\\ngYArMXJRnRjG7qh6g9TRIjZphdI3XxX9s5Rt2D8iZvuhAhqmBZjzY4PR7kxYmO2+EpCjzNnEl0XW\\n/GHaWbiIjhnAykx4N9KP7gGom3O5lzwHUme1XnFKcO2wDjQwJbufRmba8iQF1srN577mF+Z7ha4V\\nJ1duCTzvWF1KFX6sk/uhKQKBgAcDFai7rgNjJ8YcCRKxyFcMM9LKPl6hr4XFtWKzTAQPEABUkkuN\\n9gVClsg9f+VRKRECOIf0Ae1UWeCFEwxUXp4wjfHrzkTDVztKvmbWdvSXorDwKrZ7SC7tZpVFSfly\\nxuuLjadpUZT9YFmbAfY1X5oSccOMYqORjRbxEB3svb4BAoGAGTgFuq9Zojh/KIqY8b4HpEfmh6CQ\\nhLVfD98Nqd6GDbxgvIM0v4mFXE92x2jn35Ia0JdFyh3B8Vkl7sqQZfxDFXI9O9pte2mxY9ICaY\\n55+X/SN1pd53BH+gaPZJy/R+Vpvs5MN48hoUKy5UKpoFeUWrS5QArjtvNCm4SGlXw=\\n-----END RSA PRIVATE KEY-----\\n" }, "keyPairId" : "...", "owner" : "user1", "id" : "58e3946e0fb4f562d84ba1ad", "timestamp" : 1499793079011 } </code> </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 201 Looks Good Content-Type: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> </div> </div> </div> <div id="resource_KeyPairController_deleteAll_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/user/v1.0/keys/all <a href="./user/v1.0/keys/all" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <dl class="dl-horizontal"> <dt>Security Roles Allowed</dt> <dd>ADMIN</dd> </dl> <table class="table resource-response-codes"> <caption>Response Codes</caption> <thead> <tr> <th>code</th> <th>condition</th> </tr> </thead> <tbody> <tr> <td><span class="label label-warning response-code">401</span></td> <td><span class="response-condition">Bad credentials</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <caption>Response Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference">string (JSON)</span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference">string (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> DELETE /user/v1.0/keys/all Accept: application/json </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 Looks Good Content-Type: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> </div> </div> </div> <div id="resource_KeyPairController_getIds_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/keys/ids <a href="./user/v1.0/keys/ids" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p>Gets the IDs of all the stored Key</p> <dl class="dl-horizontal"> <dt>Security Roles Allowed</dt> <dd>ADMIN, USER</dd> </dl> <table class="table resource-response-codes"> <caption>Response Codes</caption> <thead> <tr> <th>code</th> <th>condition</th> </tr> </thead> <tbody> <tr> <td><span class="label label-warning response-code">401</span></td> <td><span class="response-condition">Bad credentials</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <caption>Response Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference">array of string (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description">a list of all the IDs</span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference">list of string (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> GET /user/v1.0/keys/ids Accept: application/json </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 200 Looks Good Content-Type: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> </div> </div> </div> <div id="resource_KeyPairController_geta_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/keys/sample <a href="./user/v1.0/keys/sample" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p></p> <dl class="dl-horizontal"> <dt>Security Roles Allowed</dt> <dd>ADMIN, USER</dd> </dl> <table class="table resource-response-codes"> <caption>Response Codes</caption> <thead> <tr> <th>code</th> <th>condition</th> </tr> </thead> <tbody> <tr> <td><span class="label label-warning response-code">401</span></td> <td><span class="response-condition">Bad credentials</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <caption>Response Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_KeyPair.html">KeyPair</a> (JSON)</span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_keyPair.html">keyPair</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> GET /user/v1.0/keys/sample Accept: application/json </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 200 Looks Good Content-Type: application/json <code class="prettyprint language-js"> { "privateKey" : { "name" : "id_dsa.pub", "type" : "PRIVATE", "attributes" : { "property1" : "domain_name:Virginia", "property2" : "domain_name:Virginia" }, "key" : "-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEAm6AALYxkJFNzD3bfVJ4+hMY5j0/kqM9CURLKXMlYuAysnvoG8wZKx9Bedefm\\neNSse4zTg798ZA2kDMZFIrwp1AseTwtj8DDu5fhG5DjyI3g6iJltS5zFQdMXneDlHXBX8cncSzNY\\nRx0NdjEMAe7YttvI8FNlxL0VnMFli/HB/ftzYMe5+AmkSROncVGHiwoiUpj+vtobCFOYtXsCf6ri\\nd4lgWA5wv6DZT/JKCYymiBqgSXu3ueFcEzw5SAukARWVjn1xccjZkokFfBbO/FpYY00TrUTBw9S6\\nD3iM+gj8RT6EKILOmhrt71D21S95WAWIT7h2YBsy1KAvMixhNf9VaQIDAQABAoIBAHhVYK3Xl3tr\\nN1Xm0ctJTQg3ijxhR2qsUBgGUokqezpdOoD2zbbOz7XvTYsX1GLr967U9pwxzUpELexexwiTvDgk\\nnLv8D7ui6qbRsmc4DSsWBRSophVIVFKQmftO8Xow6x+fuYJAYmsicM1KIYHBILtL+PSzV8anenWq\\nKQ3r0tfCiQhEzKEk4b1uT3SJWQyHE++JAhVkO7lIeb6S9Dg1jAaAeMnJ/NiMxTarpPRnxe6hsTsH\\ngG1iKWo+Skcl4SknOc+CMEfyDjG4FL7MGhKduahsO8vMUrgGsDD7EH3NiX/FweB8La6qpDYAwFpC\\nycrooyhiyzw8Wb5gGaYnmvr9l70CgYEAx74O8JleXaHpxEAmh4h7VbLmJ3mOylfBmOdzcHeedJQw\\nack2SAv65WBI9S9MEQ7J/vFuyw5HNk3C/mcWgzDQXSNIhHLvl/Z9sux/Qpm3SQWLzBxKV3dJ4r\\nwcAxzVA93+/L1Nee+VOKnlyRumvVa6+XLsLagpap2AVcTqlerMcCgYEAx3T2pXtqkCE9eU/ov22r\\npdaKjgHoGOUg1CMEfWi/Ch6sYIIRyrHz6dhy+yR1pXNgPbLWdrn8l88F3+IsmbaMupMgRmqwEC3G\\n9Y2FglGIVvRdZaagvRxLzRCcvcN4v6OYs9ST4o1xlv7Qxphld+0XDKv7VSCv/rASuK8BqlFL3E8C\\ngYArMXJRnRjG7qh6g9TRIjZphdI3XxX9s5Rt2D8iZvuhAhqmBZjzY4PR7kxYmO2+EpCjzNnEl0XW\\n/GHaWbiIjhnAykx4N9KP7gGom3O5lzwHUme1XnFKcO2wDjQwJbufRmba8iQF1srN577mF+Z7ha4V\\nJ1duCTzvWF1KFX6sk/uhKQKBgAcDFai7rgNjJ8YcCRKxyFcMM9LKPl6hr4XFtWKzTAQPEABUkkuN\\n9gVClsg9f+VRKRECOIf0Ae1UWeCFEwxUXp4wjfHrzkTDVztKvmbWdvSXorDwKrZ7SC7tZpVFSfly\\nxuuLjadpUZT9YFmbAfY1X5oSccOMYqORjRbxEB3svb4BAoGAGTgFuq9Zojh/KIqY8b4HpEfmh6CQ\\nhLVfD98Nqd6GDbxgvIM0v4mFXE92x2jn35Ia0JdFyh3B8Vkl7sqQZfxDFXI9O9pte2mxY9ICaY\\n55+X/SN1pd53BH+gaPZJy/R+Vpvs5MN48hoUKy5UKpoFeUWrS5QArjtvNCm4SGlXw=\\n-----END RSA PRIVATE KEY-----\\n" }, "publicKey" : { "name" : "id_dsa.pub", "type" : "PRIVATE", "attributes" : { "property1" : "domain_name:Virginia", "property2" : "domain_name:Virginia" }, "key" : "-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEAm6AALYxkJFNzD3bfVJ4+hMY5j0/kqM9CURLKXMlYuAysnvoG8wZKx9Bedefm\\neNSse4zTg798ZA2kDMZFIrwp1AseTwtj8DDu5fhG5DjyI3g6iJltS5zFQdMXneDlHXBX8cncSzNY\\nRx0NdjEMAe7YttvI8FNlxL0VnMFli/HB/ftzYMe5+AmkSROncVGHiwoiUpj+vtobCFOYtXsCf6ri\\nd4lgWA5wv6DZT/JKCYymiBqgSXu3ueFcEzw5SAukARWVjn1xccjZkokFfBbO/FpYY00TrUTBw9S6\\nD3iM+gj8RT6EKILOmhrt71D21S95WAWIT7h2YBsy1KAvMixhNf9VaQIDAQABAoIBAHhVYK3Xl3tr\\nN1Xm0ctJTQg3ijxhR2qsUBgGUokqezpdOoD2zbbOz7XvTYsX1GLr967U9pwxzUpELexexwiTvDgk\\nnLv8D7ui6qbRsmc4DSsWBRSophVIVFKQmftO8Xow6x+fuYJAYmsicM1KIYHBILtL+PSzV8anenWq\\nKQ3r0tfCiQhEzKEk4b1uT3SJWQyHE++JAhVkO7lIeb6S9Dg1jAaAeMnJ/NiMxTarpPRnxe6hsTsH\\ngG1iKWo+Skcl4SknOc+CMEfyDjG4FL7MGhKduahsO8vMUrgGsDD7EH3NiX/FweB8La6qpDYAwFpC\\nycrooyhiyzw8Wb5gGaYnmvr9l70CgYEAx74O8JleXaHpxEAmh4h7VbLmJ3mOylfBmOdzcHeedJQw\\nack2SAv65WBI9S9MEQ7J/vFuyw5HNk3C/mcWgzDQXSNIhHLvl/Z9sux/Qpm3SQWLzBxKV3dJ4r\\nwcAxzVA93+/L1Nee+VOKnlyRumvVa6+XLsLagpap2AVcTqlerMcCgYEAx3T2pXtqkCE9eU/ov22r\\npdaKjgHoGOUg1CMEfWi/Ch6sYIIRyrHz6dhy+yR1pXNgPbLWdrn8l88F3+IsmbaMupMgRmqwEC3G\\n9Y2FglGIVvRdZaagvRxLzRCcvcN4v6OYs9ST4o1xlv7Qxphld+0XDKv7VSCv/rASuK8BqlFL3E8C\\ngYArMXJRnRjG7qh6g9TRIjZphdI3XxX9s5Rt2D8iZvuhAhqmBZjzY4PR7kxYmO2+EpCjzNnEl0XW\\n/GHaWbiIjhnAykx4N9KP7gGom3O5lzwHUme1XnFKcO2wDjQwJbufRmba8iQF1srN577mF+Z7ha4V\\nJ1duCTzvWF1KFX6sk/uhKQKBgAcDFai7rgNjJ8YcCRKxyFcMM9LKPl6hr4XFtWKzTAQPEABUkkuN\\n9gVClsg9f+VRKRECOIf0Ae1UWeCFEwxUXp4wjfHrzkTDVztKvmbWdvSXorDwKrZ7SC7tZpVFSfly\\nxuuLjadpUZT9YFmbAfY1X5oSccOMYqORjRbxEB3svb4BAoGAGTgFuq9Zojh/KIqY8b4HpEfmh6CQ\\nhLVfD98Nqd6GDbxgvIM0v4mFXE92x2jn35Ia0JdFyh3B8Vkl7sqQZfxDFXI9O9pte2mxY9ICaY\\n55+X/SN1pd53BH+gaPZJy/R+Vpvs5MN48hoUKy5UKpoFeUWrS5QArjtvNCm4SGlXw=\\n-----END RSA PRIVATE KEY-----\\n" }, "keyPairId" : "...", "owner" : "user1", "id" : "58e3946e0fb4f562d84ba1ad", "timestamp" : 1499793079011 } </code> </pre> </div> </div> </div> </div> <div id="resource_KeyPairController_delete_DELETE"> <h3><span class="label label-default resource-method">DELETE</span> <span class="resource-path">/user/v1.0/keys/{id} <a href="./user/v1.0/keys/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p>Deletes a Key</p> <dl class="dl-horizontal"> <dt>Security Roles Allowed</dt> <dd>ADMIN, USER</dd> </dl> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> <th>constraints</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">id</span></td> <td>path</td> <td><span class="parameter-description"> </span></td> <td><span class="parameter-constraints">required</span></td> </tr> </tbody> </table> <table class="table resource-response-codes"> <caption>Response Codes</caption> <thead> <tr> <th>code</th> <th>condition</th> </tr> </thead> <tbody> <tr> <td><span class="label label-warning response-code">401</span></td> <td><span class="response-condition">Bad credentials</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <caption>Response Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference">string (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description">The ID of the deleted Key</span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference">string (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> DELETE /user/v1.0/keys/{id} Accept: application/json </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 204 Looks Good Content-Type: application/json <code class="prettyprint language-txt"> ... </code> </pre> </div> </div> </div> </div> <div id="resource_KeyPairController_get_GET"> <h3><span class="label label-default resource-method">GET</span> <span class="resource-path">/user/v1.0/keys/{id} <a href="./user/v1.0/keys/{id}" class="glyphicon glyphicon-new-window" target="_blank"></a></span></h3> <p>Gets the Key.</p> <dl class="dl-horizontal"> <dt>Security Roles Allowed</dt> <dd>ADMIN, USER</dd> </dl> <table class="table resource-parameters"> <caption>Request Parameters</caption> <thead> <tr> <th>name</th> <th>type</th> <th>description</th> <th>constraints</th> </tr> </thead> <tbody> <tr> <td><span class="parameter-name">id</span></td> <td>path</td> <td><span class="parameter-description">. The ID of the Key to return</span></td> <td><span class="parameter-constraints">required</span></td> </tr> </tbody> </table> <table class="table resource-response-codes"> <caption>Response Codes</caption> <thead> <tr> <th>code</th> <th>condition</th> </tr> </thead> <tbody> <tr> <td><span class="label label-warning response-code">401</span></td> <td><span class="response-condition">Bad credentials</span></td> </tr> </tbody> </table> <table class="table resource-response-body"> <caption>Response Body</caption> <thead> <tr> <th>media type</th> <th>data type</th> <th>description</th> </tr> </thead> <tbody> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/json" HTTP header to request that this media type be provided by the server."><span class="response-type">application/json</span></abbr></td> <td><span class="datatype-reference"><a href="json_KeyPair.html">KeyPair</a> (JSON)</span></td> <td rowspan="2" class="multi-row-description"><span class="response-description">The Key</span></td> </tr> <tr> <td><abbr data-toggle="tooltip" data-placement="top" title="Use the "Accept: application/xml" HTTP header to request that this media type be provided by the server."><span class="response-type">application/xml</span></abbr></td> <td><span class="datatype-reference"><a href="xml_ns0_keyPair.html">keyPair</a> (XML)</span></td> </tr> </tbody> </table> <h4>Example</h4> <div class="container-fluid example panel"> <div class="row panel-body"> <div class="col-md-6"> <h5>Request</h5> <pre> GET /user/v1.0/keys/{id} Accept: application/json </pre> </div> <div class="col-md-6"> <h5>Response</h5> <pre> HTTP/1.1 200 Looks Good Content-Type: application/json <code class="prettyprint language-js"> { "privateKey" : { "name" : "id_dsa.pub", "type" : "PRIVATE", "attributes" : { "property1" : "domain_name:Virginia", "property2" : "domain_name:Virginia" }, "key" : "-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEAm6AALYxkJFNzD3bfVJ4+hMY5j0/kqM9CURLKXMlYuAysnvoG8wZKx9Bedefm\\neNSse4zTg798ZA2kDMZFIrwp1AseTwtj8DDu5fhG5DjyI3g6iJltS5zFQdMXneDlHXBX8cncSzNY\\nRx0NdjEMAe7YttvI8FNlxL0VnMFli/HB/ftzYMe5+AmkSROncVGHiwoiUpj+vtobCFOYtXsCf6ri\\nd4lgWA5wv6DZT/JKCYymiBqgSXu3ueFcEzw5SAukARWVjn1xccjZkokFfBbO/FpYY00TrUTBw9S6\\nD3iM+gj8RT6EKILOmhrt71D21S95WAWIT7h2YBsy1KAvMixhNf9VaQIDAQABAoIBAHhVYK3Xl3tr\\nN1Xm0ctJTQg3ijxhR2qsUBgGUokqezpdOoD2zbbOz7XvTYsX1GLr967U9pwxzUpELexexwiTvDgk\\nnLv8D7ui6qbRsmc4DSsWBRSophVIVFKQmftO8Xow6x+fuYJAYmsicM1KIYHBILtL+PSzV8anenWq\\nKQ3r0tfCiQhEzKEk4b1uT3SJWQyHE++JAhVkO7lIeb6S9Dg1jAaAeMnJ/NiMxTarpPRnxe6hsTsH\\ngG1iKWo+Skcl4SknOc+CMEfyDjG4FL7MGhKduahsO8vMUrgGsDD7EH3NiX/FweB8La6qpDYAwFpC\\nycrooyhiyzw8Wb5gGaYnmvr9l70CgYEAx74O8JleXaHpxEAmh4h7VbLmJ3mOylfBmOdzcHeedJQw\\nack2SAv65WBI9S9MEQ7J/vFuyw5HNk3C/mcWgzDQXSNIhHLvl/Z9sux/Qpm3SQWLzBxKV3dJ4r\\nwcAxzVA93+/L1Nee+VOKnlyRumvVa6+XLsLagpap2AVcTqlerMcCgYEAx3T2pXtqkCE9eU/ov22r\\npdaKjgHoGOUg1CMEfWi/Ch6sYIIRyrHz6dhy+yR1pXNgPbLWdrn8l88F3+IsmbaMupMgRmqwEC3G\\n9Y2FglGIVvRdZaagvRxLzRCcvcN4v6OYs9ST4o1xlv7Qxphld+0XDKv7VSCv/rASuK8BqlFL3E8C\\ngYArMXJRnRjG7qh6g9TRIjZphdI3XxX9s5Rt2D8iZvuhAhqmBZjzY4PR7kxYmO2+EpCjzNnEl0XW\\n/GHaWbiIjhnAykx4N9KP7gGom3O5lzwHUme1XnFKcO2wDjQwJbufRmba8iQF1srN577mF+Z7ha4V\\nJ1duCTzvWF1KFX6sk/uhKQKBgAcDFai7rgNjJ8YcCRKxyFcMM9LKPl6hr4XFtWKzTAQPEABUkkuN\\n9gVClsg9f+VRKRECOIf0Ae1UWeCFEwxUXp4wjfHrzkTDVztKvmbWdvSXorDwKrZ7SC7tZpVFSfly\\nxuuLjadpUZT9YFmbAfY1X5oSccOMYqORjRbxEB3svb4BAoGAGTgFuq9Zojh/KIqY8b4HpEfmh6CQ\\nhLVfD98Nqd6GDbxgvIM0v4mFXE92x2jn35Ia0JdFyh3B8Vkl7sqQZfxDFXI9O9pte2mxY9ICaY\\n55+X/SN1pd53BH+gaPZJy/R+Vpvs5MN48hoUKy5UKpoFeUWrS5QArjtvNCm4SGlXw=\\n-----END RSA PRIVATE KEY-----\\n" }, "publicKey" : { "name" : "id_dsa.pub", "type" : "PRIVATE", "attributes" : { "property1" : "domain_name:Virginia", "property2" : "domain_name:Virginia" }, "key" : "-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEAm6AALYxkJFNzD3bfVJ4+hMY5j0/kqM9CURLKXMlYuAysnvoG8wZKx9Bedefm\\neNSse4zTg798ZA2kDMZFIrwp1AseTwtj8DDu5fhG5DjyI3g6iJltS5zFQdMXneDlHXBX8cncSzNY\\nRx0NdjEMAe7YttvI8FNlxL0VnMFli/HB/ftzYMe5+AmkSROncVGHiwoiUpj+vtobCFOYtXsCf6ri\\nd4lgWA5wv6DZT/JKCYymiBqgSXu3ueFcEzw5SAukARWVjn1xccjZkokFfBbO/FpYY00TrUTBw9S6\\nD3iM+gj8RT6EKILOmhrt71D21S95WAWIT7h2YBsy1KAvMixhNf9VaQIDAQABAoIBAHhVYK3Xl3tr\\nN1Xm0ctJTQg3ijxhR2qsUBgGUokqezpdOoD2zbbOz7XvTYsX1GLr967U9pwxzUpELexexwiTvDgk\\nnLv8D7ui6qbRsmc4DSsWBRSophVIVFKQmftO8Xow6x+fuYJAYmsicM1KIYHBILtL+PSzV8anenWq\\nKQ3r0tfCiQhEzKEk4b1uT3SJWQyHE++JAhVkO7lIeb6S9Dg1jAaAeMnJ/NiMxTarpPRnxe6hsTsH\\ngG1iKWo+Skcl4SknOc+CMEfyDjG4FL7MGhKduahsO8vMUrgGsDD7EH3NiX/FweB8La6qpDYAwFpC\\nycrooyhiyzw8Wb5gGaYnmvr9l70CgYEAx74O8JleXaHpxEAmh4h7VbLmJ3mOylfBmOdzcHeedJQw\\nack2SAv65WBI9S9MEQ7J/vFuyw5HNk3C/mcWgzDQXSNIhHLvl/Z9sux/Qpm3SQWLzBxKV3dJ4r\\nwcAxzVA93+/L1Nee+VOKnlyRumvVa6+XLsLagpap2AVcTqlerMcCgYEAx3T2pXtqkCE9eU/ov22r\\npdaKjgHoGOUg1CMEfWi/Ch6sYIIRyrHz6dhy+yR1pXNgPbLWdrn8l88F3+IsmbaMupMgRmqwEC3G\\n9Y2FglGIVvRdZaagvRxLzRCcvcN4v6OYs9ST4o1xlv7Qxphld+0XDKv7VSCv/rASuK8BqlFL3E8C\\ngYArMXJRnRjG7qh6g9TRIjZphdI3XxX9s5Rt2D8iZvuhAhqmBZjzY4PR7kxYmO2+EpCjzNnEl0XW\\n/GHaWbiIjhnAykx4N9KP7gGom3O5lzwHUme1XnFKcO2wDjQwJbufRmba8iQF1srN577mF+Z7ha4V\\nJ1duCTzvWF1KFX6sk/uhKQKBgAcDFai7rgNjJ8YcCRKxyFcMM9LKPl6hr4XFtWKzTAQPEABUkkuN\\n9gVClsg9f+VRKRECOIf0Ae1UWeCFEwxUXp4wjfHrzkTDVztKvmbWdvSXorDwKrZ7SC7tZpVFSfly\\nxuuLjadpUZT9YFmbAfY1X5oSccOMYqORjRbxEB3svb4BAoGAGTgFuq9Zojh/KIqY8b4HpEfmh6CQ\\nhLVfD98Nqd6GDbxgvIM0v4mFXE92x2jn35Ia0JdFyh3B8Vkl7sqQZfxDFXI9O9pte2mxY9ICaY\\n55+X/SN1pd53BH+gaPZJy/R+Vpvs5MN48hoUKy5UKpoFeUWrS5QArjtvNCm4SGlXw=\\n-----END RSA PRIVATE KEY-----\\n" }, "keyPairId" : "...", "owner" : "user1", "id" : "58e3946e0fb4f562d84ba1ad", "timestamp" : 1499793079011 } </code> </pre> </div> </div> </div> </div> <footer class="footer"> <div class="container"> <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p> </div> </footer> </div> </div> </div> <!-- JavaScript placed at the end of the document so the pages load faster. --> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script> <!-- Bootstrap core JavaScript ================================================== --> <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script> <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ --> <script src="https://cdn.rawgit.com/google/code-prettify/master/loader/run_prettify.js" type="text/javascript"></script> <script> $(function() { $(".clickable-row").click(function() { window.document.location = $(this).data("href"); }); $('[data-toggle="tooltip"]').tooltip() }); </script> </body> </html>