docs/api_swagger.html

   1 <!doctype html>
   2 <html>
   3   <head>
   4     <title>Secret Management Service</title>
   5     <style type="text/css">
   6       body {
   7         font-family: Trebuchet MS, sans-serif;
   8         font-size: 15px;
   9         color: #444;
  10         margin-right: 24px;
  11 }
  12
  13 h1      {
  14         font-size: 25px;
  15 }
  16 h2      {
  17         font-size: 20px;
  18 }
  19 h3      {
  20         font-size: 16px;
  21         font-weight: bold;
  22 }
  23 hr      {
  24         height: 1px;
  25         border: 0;
  26         color: #ddd;
  27         background-color: #ddd;
  28 }
  29
  30 .app-desc {
  31   clear: both;
  32   margin-left: 20px;
  33 }
  34 .param-name {
  35   width: 100%;
  36 }
  37 .license-info {
  38   margin-left: 20px;
  39 }
  40
  41 .license-url {
  42   margin-left: 20px;
  43 }
  44
  45 .model {
  46   margin: 0 0 0px 20px;
  47 }
  48
  49 .method {
  50   margin-left: 20px;
  51 }
  52
  53 .method-notes   {
  54         margin: 10px 0 20px 0;
  55         font-size: 90%;
  56         color: #555;
  57 }
  58
  59 pre {
  60   padding: 10px;
  61   margin-bottom: 2px;
  62 }
  63
  64 .http-method {
  65  text-transform: uppercase;
  66 }
  67
  68 pre.get {
  69   background-color: #0f6ab4;
  70 }
  71
  72 pre.post {
  73   background-color: #10a54a;
  74 }
  75
  76 pre.put {
  77   background-color: #c5862b;
  78 }
  79
  80 pre.delete {
  81   background-color: #a41e22;
  82 }
  83
  84 .huge   {
  85         color: #fff;
  86 }
  87
  88 pre.example {
  89   background-color: #f3f3f3;
  90   padding: 10px;
  91   border: 1px solid #ddd;
  92 }
  93
  94 code {
  95   white-space: pre;
  96 }
  97
  98 .nickname {
  99   font-weight: bold;
 100 }
 101
 102 .method-path {
 103   font-size: 1.5em;
 104   background-color: #0f6ab4;
 105 }
 106
 107 .up {
 108   float:right;
 109 }
 110
 111 .parameter {
 112   width: 500px;
 113 }
 114
 115 .param {
 116   width: 500px;
 117   padding: 10px 0 0 20px;
 118   font-weight: bold;
 119 }
 120
 121 .param-desc {
 122   width: 700px;
 123   padding: 0 0 0 20px;
 124   color: #777;
 125 }
 126
 127 .param-type {
 128   font-style: italic;
 129 }
 130
 131 .param-enum-header {
 132 width: 700px;
 133 padding: 0 0 0 60px;
 134 color: #777;
 135 font-weight: bold;
 136 }
 137
 138 .param-enum {
 139 width: 700px;
 140 padding: 0 0 0 80px;
 141 color: #777;
 142 font-style: italic;
 143 }
 144
 145 .field-label {
 146   padding: 0;
 147   margin: 0;
 148   clear: both;
 149 }
 150
 151 .field-items    {
 152         padding: 0 0 15px 0;
 153         margin-bottom: 15px;
 154 }
 155
 156 .return-type {
 157   clear: both;
 158   padding-bottom: 10px;
 159 }
 160
 161 .param-header {
 162   font-weight: bold;
 163 }
 164
 165 .method-tags {
 166   text-align: right;
 167 }
 168
 169 .method-tag {
 170   background: none repeat scroll 0% 0% #24A600;
 171   border-radius: 3px;
 172   padding: 2px 10px;
 173   margin: 2px;
 174   color: #FFF;
 175   display: inline-block;
 176   text-decoration: none;
 177 }
 178
 179     </style>
 180   </head>
 181   <body>
 182   <h1>Secret Management Service</h1>
 183     <div class="app-desc">This is a service that provides secret management facilities</div>
 184     <div class="app-desc">More information: <a href="https://helloreverb.com">https://helloreverb.com</a></div>
 185     <div class="app-desc">Contact Info: <a href="kiran.k.kamineni@intel.com">kiran.k.kamineni@intel.com</a></div>
 186     <div class="app-desc">Version: 1.0.0</div>
 187     <div class="app-desc">BasePath:/v1/sms/</div>
 188     <div class="license-info">Apache 2.0</div>
 189     <div class="license-url">http://www.apache.org/licenses/LICENSE-2.0.html</div>
 190   <h2>Access</h2>
 191     <ol>
 192       <li>APIKey KeyParamName:token KeyInQuery:false KeyInHeader:true</li>
 193     </ol>
 194
 195   <h2><a name="__Methods">Methods</a></h2>
 196   [ Jump to <a href="#__Models">Models</a> ]
 197
 198   <h3>Table of Contents </h3>
 199   <div class="method-summary"></div>
 200   <h4><a href="#Domain">Domain</a></h4>
 201   <ul>
 202   <li><a href="#domainDomainNameDelete"><code><span class="http-method">delete</span> /domain/{domainName}</code></a></li>
 203   <li><a href="#domainPost"><code><span class="http-method">post</span> /domain</code></a></li>
 204   </ul>
 205   <h4><a href="#Login">Login</a></h4>
 206   <ul>
 207   <li><a href="#loginPost"><code><span class="http-method">post</span> /login</code></a></li>
 208   </ul>
 209   <h4><a href="#Secret">Secret</a></h4>
 210   <ul>
 211   <li><a href="#domainDomainNameSecretGet"><code><span class="http-method">get</span> /domain/{domainName}/secret</code></a></li>
 212   <li><a href="#domainDomainNameSecretPost"><code><span class="http-method">post</span> /domain/{domainName}/secret</code></a></li>
 213   <li><a href="#domainDomainNameSecretSecretNameDelete"><code><span class="http-method">delete</span> /domain/{domainName}/secret/{secretName}</code></a></li>
 214   <li><a href="#domainDomainNameSecretSecretNameGet"><code><span class="http-method">get</span> /domain/{domainName}/secret/{secretName}</code></a></li>
 215   </ul>
 216   <h4><a href="#System">System</a></h4>
 217   <ul>
 218   <li><a href="#statusGet"><code><span class="http-method">get</span> /status</code></a></li>
 219   <li><a href="#unsealPost"><code><span class="http-method">post</span> /unseal</code></a></li>
 220   </ul>
 221
 222   <h1><a name="Domain">Domain</a></h1>
 223   <div class="method"><a name="domainDomainNameDelete"/>
 224     <div class="method-path">
 225     <a class="up" href="#__Methods">Up</a>
 226     <pre class="delete"><code class="huge"><span class="http-method">delete</span> /domain/{domainName}</code></pre></div>
 227     <div class="method-summary">Deletes a domain by name (<span class="nickname">domainDomainNameDelete</span>)</div>
 228     <div class="method-notes">Deletes a domain with provided name</div>
 229
 230     <h3 class="field-label">Path parameters</h3>
 231     <div class="field-items">
 232       <div class="param">domainName (required)</div>
 233
 234       <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Name of the domain </div>
 235     </div>  <!-- field-items -->
 236
 237
 238
 239
 240
 241
 242
 243     <!--Todo: process Response Object and its headers, schema, examples -->
 244
 245
 246     <h3 class="field-label">Produces</h3>
 247     This API call produces the following media types according to the <span class="header">Accept</span> request header;
 248     the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
 249     <ul>
 250       <li><code>application/json</code></li>
 251     </ul>
 252
 253     <h3 class="field-label">Responses</h3>
 254     <h4 class="field-label">204</h4>
 255     Successful Deletion
 256         <a href="#"></a>
 257     <h4 class="field-label">404</h4>
 258     Invalid Path or Path not found
 259         <a href="#"></a>
 260   </div> <!-- method -->
 261   <hr/>
 262   <div class="method"><a name="domainPost"/>
 263     <div class="method-path">
 264     <a class="up" href="#__Methods">Up</a>
 265     <pre class="post"><code class="huge"><span class="http-method">post</span> /domain</code></pre></div>
 266     <div class="method-summary">Add a new domain (<span class="nickname">domainPost</span>)</div>
 267     <div class="method-notes"></div>
 268
 269
 270     <h3 class="field-label">Consumes</h3>
 271     This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
 272     <ul>
 273       <li><code>application/json</code></li>
 274     </ul>
 275
 276     <h3 class="field-label">Request body</h3>
 277     <div class="field-items">
 278       <div class="param">body <a href="#Domain">Domain</a> (required)</div>
 279
 280       <div class="param-desc"><span class="param-type">Body Parameter</span> &mdash;  </div>
 281
 282     </div>  <!-- field-items -->
 283
 284
 285
 286
 287     <h3 class="field-label">Return type</h3>
 288     <div class="return-type">
 289       <a href="#Domain">Domain</a>
 290
 291     </div>
 292
 293     <!--Todo: process Response Object and its headers, schema, examples -->
 294
 295     <h3 class="field-label">Example data</h3>
 296     <div class="example-data-content-type">Content-Type: application/json</div>
 297     <pre class="example"><code>{
 298   "name" : "name",
 299   "uuid" : "uuid"
 300 }</code></pre>
 301
 302     <h3 class="field-label">Produces</h3>
 303     This API call produces the following media types according to the <span class="header">Accept</span> request header;
 304     the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
 305     <ul>
 306       <li><code>application/json</code></li>
 307     </ul>
 308
 309     <h3 class="field-label">Responses</h3>
 310     <h4 class="field-label">201</h4>
 311     Successful Creation
 312         <a href="#Domain">Domain</a>
 313     <h4 class="field-label">400</h4>
 314     Invalid input
 315         <a href="#"></a>
 316     <h4 class="field-label">500</h4>
 317     Internal Server Error
 318         <a href="#"></a>
 319   </div> <!-- method -->
 320   <hr/>
 321   <h1><a name="Login">Login</a></h1>
 322   <div class="method"><a name="loginPost"/>
 323     <div class="method-path">
 324     <a class="up" href="#__Methods">Up</a>
 325     <pre class="post"><code class="huge"><span class="http-method">post</span> /login</code></pre></div>
 326     <div class="method-summary">Login with username and password (<span class="nickname">loginPost</span>)</div>
 327     <div class="method-notes">Operations related to logging in via username and Password</div>
 328
 329
 330     <h3 class="field-label">Consumes</h3>
 331     This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
 332     <ul>
 333       <li><code>application/json</code></li>
 334     </ul>
 335
 336     <h3 class="field-label">Request body</h3>
 337     <div class="field-items">
 338       <div class="param">body <a href="#Credential">Credential</a> (required)</div>
 339
 340       <div class="param-desc"><span class="param-type">Body Parameter</span> &mdash;  </div>
 341
 342     </div>  <!-- field-items -->
 343
 344
 345
 346
 347     <h3 class="field-label">Return type</h3>
 348     <div class="return-type">
 349       <a href="#inline_response_200">inline_response_200</a>
 350
 351     </div>
 352
 353     <!--Todo: process Response Object and its headers, schema, examples -->
 354
 355     <h3 class="field-label">Example data</h3>
 356     <div class="example-data-content-type">Content-Type: application/json</div>
 357     <pre class="example"><code>{
 358   "ttl" : 0,
 359   "token" : "token"
 360 }</code></pre>
 361
 362     <h3 class="field-label">Produces</h3>
 363     This API call produces the following media types according to the <span class="header">Accept</span> request header;
 364     the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
 365     <ul>
 366       <li><code>application/json</code></li>
 367     </ul>
 368
 369     <h3 class="field-label">Responses</h3>
 370     <h4 class="field-label">200</h4>
 371     Successful Login returns a token
 372         <a href="#inline_response_200">inline_response_200</a>
 373     <h4 class="field-label">404</h4>
 374     Invalid Username or Password
 375         <a href="#"></a>
 376   </div> <!-- method -->
 377   <hr/>
 378   <h1><a name="Secret">Secret</a></h1>
 379   <div class="method"><a name="domainDomainNameSecretGet"/>
 380     <div class="method-path">
 381     <a class="up" href="#__Methods">Up</a>
 382     <pre class="get"><code class="huge"><span class="http-method">get</span> /domain/{domainName}/secret</code></pre></div>
 383     <div class="method-summary">List secret Names in this domain (<span class="nickname">domainDomainNameSecretGet</span>)</div>
 384     <div class="method-notes">Gets all secret names in this domain</div>
 385
 386     <h3 class="field-label">Path parameters</h3>
 387     <div class="field-items">
 388       <div class="param">domainName (required)</div>
 389
 390       <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Name of the domain in which to look at </div>
 391     </div>  <!-- field-items -->
 392
 393
 394
 395
 396
 397
 398     <h3 class="field-label">Return type</h3>
 399     <div class="return-type">
 400       <a href="#inline_response_200_2">inline_response_200_2</a>
 401
 402     </div>
 403
 404     <!--Todo: process Response Object and its headers, schema, examples -->
 405
 406     <h3 class="field-label">Example data</h3>
 407     <div class="example-data-content-type">Content-Type: application/json</div>
 408     <pre class="example"><code>"{\"secretnames\":[\"secretname1\",\"secretname2\",\"secretname3\"]}"</code></pre>
 409
 410     <h3 class="field-label">Produces</h3>
 411     This API call produces the following media types according to the <span class="header">Accept</span> request header;
 412     the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
 413     <ul>
 414       <li><code>application/json</code></li>
 415     </ul>
 416
 417     <h3 class="field-label">Responses</h3>
 418     <h4 class="field-label">200</h4>
 419     Successful operation
 420         <a href="#inline_response_200_2">inline_response_200_2</a>
 421     <h4 class="field-label">404</h4>
 422     Invalid Path or Path not found
 423         <a href="#"></a>
 424   </div> <!-- method -->
 425   <hr/>
 426   <div class="method"><a name="domainDomainNameSecretPost"/>
 427     <div class="method-path">
 428     <a class="up" href="#__Methods">Up</a>
 429     <pre class="post"><code class="huge"><span class="http-method">post</span> /domain/{domainName}/secret</code></pre></div>
 430     <div class="method-summary">Add a new secret (<span class="nickname">domainDomainNameSecretPost</span>)</div>
 431     <div class="method-notes"></div>
 432
 433     <h3 class="field-label">Path parameters</h3>
 434     <div class="field-items">
 435       <div class="param">domainName (required)</div>
 436
 437       <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Name of the domain </div>
 438     </div>  <!-- field-items -->
 439
 440     <h3 class="field-label">Consumes</h3>
 441     This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
 442     <ul>
 443       <li><code>application/json</code></li>
 444     </ul>
 445
 446     <h3 class="field-label">Request body</h3>
 447     <div class="field-items">
 448       <div class="param">body <a href="#Secret">Secret</a> (required)</div>
 449
 450       <div class="param-desc"><span class="param-type">Body Parameter</span> &mdash;  </div>
 451
 452     </div>  <!-- field-items -->
 453
 454
 455
 456
 457
 458     <!--Todo: process Response Object and its headers, schema, examples -->
 459
 460
 461     <h3 class="field-label">Produces</h3>
 462     This API call produces the following media types according to the <span class="header">Accept</span> request header;
 463     the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
 464     <ul>
 465       <li><code>application/json</code></li>
 466     </ul>
 467
 468     <h3 class="field-label">Responses</h3>
 469     <h4 class="field-label">201</h4>
 470     Successful Creation
 471         <a href="#"></a>
 472     <h4 class="field-label">404</h4>
 473     Invalid Path or Path not found
 474         <a href="#"></a>
 475   </div> <!-- method -->
 476   <hr/>
 477   <div class="method"><a name="domainDomainNameSecretSecretNameDelete"/>
 478     <div class="method-path">
 479     <a class="up" href="#__Methods">Up</a>
 480     <pre class="delete"><code class="huge"><span class="http-method">delete</span> /domain/{domainName}/secret/{secretName}</code></pre></div>
 481     <div class="method-summary">Deletes a Secret (<span class="nickname">domainDomainNameSecretSecretNameDelete</span>)</div>
 482     <div class="method-notes"></div>
 483
 484     <h3 class="field-label">Path parameters</h3>
 485     <div class="field-items">
 486       <div class="param">secretName (required)</div>
 487
 488       <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Name of Secret to Delete </div><div class="param">domainName (required)</div>
 489
 490       <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Path to the SecretDomain which contains the Secret </div>
 491     </div>  <!-- field-items -->
 492
 493
 494
 495
 496
 497
 498
 499     <!--Todo: process Response Object and its headers, schema, examples -->
 500
 501
 502     <h3 class="field-label">Produces</h3>
 503     This API call produces the following media types according to the <span class="header">Accept</span> request header;
 504     the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
 505     <ul>
 506       <li><code>application/json</code></li>
 507     </ul>
 508
 509     <h3 class="field-label">Responses</h3>
 510     <h4 class="field-label">204</h4>
 511     Successful Deletion
 512         <a href="#"></a>
 513     <h4 class="field-label">404</h4>
 514     Invalid Path or Path not found
 515         <a href="#"></a>
 516   </div> <!-- method -->
 517   <hr/>
 518   <div class="method"><a name="domainDomainNameSecretSecretNameGet"/>
 519     <div class="method-path">
 520     <a class="up" href="#__Methods">Up</a>
 521     <pre class="get"><code class="huge"><span class="http-method">get</span> /domain/{domainName}/secret/{secretName}</code></pre></div>
 522     <div class="method-summary">Find Secret by Name (<span class="nickname">domainDomainNameSecretSecretNameGet</span>)</div>
 523     <div class="method-notes">Returns a single secret</div>
 524
 525     <h3 class="field-label">Path parameters</h3>
 526     <div class="field-items">
 527       <div class="param">domainName (required)</div>
 528
 529       <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Name of the domain in which to look at </div><div class="param">secretName (required)</div>
 530
 531       <div class="param-desc"><span class="param-type">Path Parameter</span> &mdash; Name of the secret which is needed </div>
 532     </div>  <!-- field-items -->
 533
 534
 535
 536
 537
 538
 539     <h3 class="field-label">Return type</h3>
 540     <div class="return-type">
 541       <a href="#Secret">Secret</a>
 542
 543     </div>
 544
 545     <!--Todo: process Response Object and its headers, schema, examples -->
 546
 547     <h3 class="field-label">Example data</h3>
 548     <div class="example-data-content-type">Content-Type: application/json</div>
 549     <pre class="example"><code>{
 550   "values" : {
 551     "name" : "john",
 552     "Age" : 40,
 553     "admin" : true
 554   },
 555   "name" : "name"
 556 }</code></pre>
 557
 558     <h3 class="field-label">Produces</h3>
 559     This API call produces the following media types according to the <span class="header">Accept</span> request header;
 560     the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
 561     <ul>
 562       <li><code>application/json</code></li>
 563     </ul>
 564
 565     <h3 class="field-label">Responses</h3>
 566     <h4 class="field-label">200</h4>
 567     successful operation
 568         <a href="#Secret">Secret</a>
 569     <h4 class="field-label">404</h4>
 570     Invalid Path or Path not found
 571         <a href="#"></a>
 572   </div> <!-- method -->
 573   <hr/>
 574   <h1><a name="System">System</a></h1>
 575   <div class="method"><a name="statusGet"/>
 576     <div class="method-path">
 577     <a class="up" href="#__Methods">Up</a>
 578     <pre class="get"><code class="huge"><span class="http-method">get</span> /status</code></pre></div>
 579     <div class="method-summary">Get backend status (<span class="nickname">statusGet</span>)</div>
 580     <div class="method-notes">Gets current backend status. This API is used only by quorum clients</div>
 581
 582
 583
 584
 585
 586
 587
 588     <h3 class="field-label">Return type</h3>
 589     <div class="return-type">
 590       <a href="#inline_response_200_1">inline_response_200_1</a>
 591
 592     </div>
 593
 594     <!--Todo: process Response Object and its headers, schema, examples -->
 595
 596     <h3 class="field-label">Example data</h3>
 597     <div class="example-data-content-type">Content-Type: application/json</div>
 598     <pre class="example"><code>{
 599   "sealstatus" : "sealstatus"
 600 }</code></pre>
 601
 602     <h3 class="field-label">Produces</h3>
 603     This API call produces the following media types according to the <span class="header">Accept</span> request header;
 604     the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
 605     <ul>
 606       <li><code>application/json</code></li>
 607     </ul>
 608
 609     <h3 class="field-label">Responses</h3>
 610     <h4 class="field-label">200</h4>
 611     Successful operation
 612         <a href="#inline_response_200_1">inline_response_200_1</a>
 613     <h4 class="field-label">404</h4>
 614     Invalid Path or Path not found
 615         <a href="#"></a>
 616   </div> <!-- method -->
 617   <hr/>
 618   <div class="method"><a name="unsealPost"/>
 619     <div class="method-path">
 620     <a class="up" href="#__Methods">Up</a>
 621     <pre class="post"><code class="huge"><span class="http-method">post</span> /unseal</code></pre></div>
 622     <div class="method-summary">Unseal backend (<span class="nickname">unsealPost</span>)</div>
 623     <div class="method-notes">Sends unseal shard to unseal if backend is sealed</div>
 624
 625
 626     <h3 class="field-label">Consumes</h3>
 627     This API call consumes the following media types via the <span class="heaader">Content-Type</span> request header:
 628     <ul>
 629       <li><code>application/json</code></li>
 630     </ul>
 631
 632     <h3 class="field-label">Request body</h3>
 633     <div class="field-items">
 634       <div class="param">body <a href="#body">body</a> (required)</div>
 635
 636       <div class="param-desc"><span class="param-type">Body Parameter</span> &mdash;  </div>
 637
 638     </div>  <!-- field-items -->
 639
 640
 641
 642
 643
 644     <!--Todo: process Response Object and its headers, schema, examples -->
 645
 646
 647     <h3 class="field-label">Produces</h3>
 648     This API call produces the following media types according to the <span class="header">Accept</span> request header;
 649     the media type will be conveyed by the <span class="heaader">Content-Type</span> response header.
 650     <ul>
 651       <li><code>application/json</code></li>
 652     </ul>
 653
 654     <h3 class="field-label">Responses</h3>
 655     <h4 class="field-label">201</h4>
 656     Submitted unseal key
 657         <a href="#"></a>
 658     <h4 class="field-label">404</h4>
 659     Invalid Path or Path not found
 660         <a href="#"></a>
 661   </div> <!-- method -->
 662   <hr/>
 663
 664   <h2><a name="__Models">Models</a></h2>
 665   [ Jump to <a href="#__Methods">Methods</a> ]
 666
 667   <h3>Table of Contents</h3>
 668   <ol>
 669     <li><a href="#Credential"><code>Credential</code> - </a></li>
 670     <li><a href="#Domain"><code>Domain</code> - </a></li>
 671     <li><a href="#Secret"><code>Secret</code> - </a></li>
 672     <li><a href="#body"><code>body</code> - </a></li>
 673     <li><a href="#inline_response_200"><code>inline_response_200</code> - </a></li>
 674     <li><a href="#inline_response_200_1"><code>inline_response_200_1</code> - </a></li>
 675     <li><a href="#inline_response_200_2"><code>inline_response_200_2</code> - </a></li>
 676   </ol>
 677
 678   <div class="model">
 679     <h3><a name="Credential"><code>Credential</code> - </a> <a class="up" href="#__Models">Up</a></h3>
 680     <div class='model-description'></div>
 681     <div class="field-items">
 682       <div class="param">username (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
 683 <div class="param">password (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
 684     </div>  <!-- field-items -->
 685   </div>
 686   <div class="model">
 687     <h3><a name="Domain"><code>Domain</code> - </a> <a class="up" href="#__Models">Up</a></h3>
 688     <div class='model-description'></div>
 689     <div class="field-items">
 690       <div class="param">uuid (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Optional value provided by user. If user does not provide, server will auto generate </div>
 691 <div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Name of the secret domain under which all secrets will be stored </div>
 692     </div>  <!-- field-items -->
 693   </div>
 694   <div class="model">
 695     <h3><a name="Secret"><code>Secret</code> - </a> <a class="up" href="#__Models">Up</a></h3>
 696     <div class='model-description'></div>
 697     <div class="field-items">
 698       <div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Name of the secret </div>
 699 <div class="param">values (optional)</div><div class="param-desc"><span class="param-type"><a href="#object">map[String, Object]</a></span> Map of key value pairs that constitute the secret </div>
 700     </div>  <!-- field-items -->
 701   </div>
 702   <div class="model">
 703     <h3><a name="body"><code>body</code> - </a> <a class="up" href="#__Models">Up</a></h3>
 704
 705     <div class="field-items">
 706       <div class="param">unsealshard (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Unseal shard that will be used along with other shards to unseal backend </div>
 707     </div>  <!-- field-items -->
 708   </div>
 709   <div class="model">
 710     <h3><a name="inline_response_200"><code>inline_response_200</code> - </a> <a class="up" href="#__Models">Up</a></h3>
 711
 712     <div class="field-items">
 713       <div class="param">token (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
 714 <div class="param">ttl (optional)</div><div class="param-desc"><span class="param-type"><a href="#integer">Integer</a></span> ttl of returned token in seconds </div>
 715     </div>  <!-- field-items -->
 716   </div>
 717   <div class="model">
 718     <h3><a name="inline_response_200_1"><code>inline_response_200_1</code> - </a> <a class="up" href="#__Models">Up</a></h3>
 719
 720     <div class="field-items">
 721       <div class="param">sealstatus (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> seal status of backend </div>
 722     </div>  <!-- field-items -->
 723   </div>
 724   <div class="model">
 725     <h3><a name="inline_response_200_2"><code>inline_response_200_2</code> - </a> <a class="up" href="#__Models">Up</a></h3>
 726
 727     <div class="field-items">
 728       <div class="param">secretnames (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">array[String]</a></span> Array of strings referencing the secret names </div>
 729     </div>  <!-- field-items -->
 730   </div>
 731   </body>
 732 </html>