1 | <!DOCTYPE html>
|
2 | <html lang="en">
|
3 | <head>
|
4 | <meta charset="utf-8">
|
5 | <title>JSDoc: Module: authn</title>
|
6 |
|
7 | <script src="scripts/prettify/prettify.js"> </script>
|
8 | <script src="scripts/prettify/lang-css.js"> </script>
|
9 | |
10 |
|
11 |
|
12 | <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
13 | <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
14 | </head>
|
15 |
|
16 | <body>
|
17 |
|
18 | <div id="main">
|
19 |
|
20 | <h1 class="page-title">Module: authn</h1>
|
21 |
|
22 |
|
23 |
|
24 |
|
25 |
|
26 |
|
27 | <section>
|
28 |
|
29 | <header>
|
30 |
|
31 |
|
32 |
|
33 | </header>
|
34 |
|
35 | <article>
|
36 | <div class="container-overview">
|
37 |
|
38 |
|
39 |
|
40 |
|
41 |
|
42 | </div>
|
43 |
|
44 |
|
45 |
|
46 |
|
47 |
|
48 |
|
49 |
|
50 |
|
51 |
|
52 |
|
53 |
|
54 |
|
55 |
|
56 |
|
57 |
|
58 |
|
59 | <h3 class="subsection-title">Methods</h3>
|
60 |
|
61 |
|
62 |
|
63 |
|
64 |
|
65 |
|
66 |
|
67 | <h4 class="name" id=".authenticate"><span class="type-signature">(static) </span>authenticate<span class="signature">(host, user, passwordOrUri, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
68 |
|
69 |
|
70 |
|
71 |
|
72 |
|
73 |
|
74 | <div class="description">
|
75 | <p>Implements token auth</p>
|
76 | </div>
|
77 |
|
78 |
|
79 |
|
80 |
|
81 |
|
82 |
|
83 |
|
84 |
|
85 |
|
86 | <h5>Parameters:</h5>
|
87 |
|
88 |
|
89 | <table class="params">
|
90 | <thead>
|
91 | <tr>
|
92 |
|
93 | <th>Name</th>
|
94 |
|
95 |
|
96 | <th>Type</th>
|
97 |
|
98 |
|
99 | <th>Attributes</th>
|
100 |
|
101 |
|
102 |
|
103 |
|
104 | <th class="last">Description</th>
|
105 | </tr>
|
106 | </thead>
|
107 |
|
108 | <tbody>
|
109 |
|
110 |
|
111 | <tr>
|
112 |
|
113 | <td class="name"><code>host</code></td>
|
114 |
|
115 |
|
116 | <td class="type">
|
117 |
|
118 |
|
119 | <span class="param-type">String</span>
|
120 |
|
121 |
|
122 |
|
123 | </td>
|
124 |
|
125 |
|
126 | <td class="attributes">
|
127 |
|
128 |
|
129 |
|
130 |
|
131 |
|
132 | </td>
|
133 |
|
134 |
|
135 |
|
136 |
|
137 | <td class="description last"><p>Host to connect to.</p></td>
|
138 | </tr>
|
139 |
|
140 |
|
141 |
|
142 | <tr>
|
143 |
|
144 | <td class="name"><code>user</code></td>
|
145 |
|
146 |
|
147 | <td class="type">
|
148 |
|
149 |
|
150 | <span class="param-type">String</span>
|
151 |
|
152 |
|
153 |
|
154 | </td>
|
155 |
|
156 |
|
157 | <td class="attributes">
|
158 |
|
159 |
|
160 |
|
161 |
|
162 |
|
163 | </td>
|
164 |
|
165 |
|
166 |
|
167 |
|
168 | <td class="description last"><p>User (with admin rights).</p></td>
|
169 | </tr>
|
170 |
|
171 |
|
172 |
|
173 | <tr>
|
174 |
|
175 | <td class="name"><code>passwordOrUri</code></td>
|
176 |
|
177 |
|
178 | <td class="type">
|
179 |
|
180 |
|
181 | <span class="param-type">String</span>
|
182 |
|
183 |
|
184 |
|
185 | </td>
|
186 |
|
187 |
|
188 | <td class="attributes">
|
189 |
|
190 |
|
191 |
|
192 |
|
193 |
|
194 | </td>
|
195 |
|
196 |
|
197 |
|
198 |
|
199 | <td class="description last"><p>Password for user or URI (file, http, https, ARN, etc.)
|
200 | to location containing password.</p></td>
|
201 | </tr>
|
202 |
|
203 |
|
204 |
|
205 | <tr>
|
206 |
|
207 | <td class="name"><code>options</code></td>
|
208 |
|
209 |
|
210 | <td class="type">
|
211 |
|
212 |
|
213 | <span class="param-type">Object</span>
|
214 |
|
215 |
|
216 |
|
217 | </td>
|
218 |
|
219 |
|
220 | <td class="attributes">
|
221 |
|
222 | <optional><br>
|
223 |
|
224 |
|
225 |
|
226 |
|
227 |
|
228 | </td>
|
229 |
|
230 |
|
231 |
|
232 |
|
233 | <td class="description last"><p>Optional parameters.</p>
|
234 | <h6>Properties</h6>
|
235 |
|
236 |
|
237 | <table class="params">
|
238 | <thead>
|
239 | <tr>
|
240 |
|
241 | <th>Name</th>
|
242 |
|
243 |
|
244 | <th>Type</th>
|
245 |
|
246 |
|
247 | <th>Attributes</th>
|
248 |
|
249 |
|
250 |
|
251 |
|
252 | <th class="last">Description</th>
|
253 | </tr>
|
254 | </thead>
|
255 |
|
256 | <tbody>
|
257 |
|
258 |
|
259 | <tr>
|
260 |
|
261 | <td class="name"><code>product</code></td>
|
262 |
|
263 |
|
264 | <td class="type">
|
265 |
|
266 |
|
267 | <span class="param-type">String</span>
|
268 |
|
269 |
|
270 |
|
271 | </td>
|
272 |
|
273 |
|
274 | <td class="attributes">
|
275 |
|
276 | <optional><br>
|
277 |
|
278 |
|
279 |
|
280 |
|
281 |
|
282 | </td>
|
283 |
|
284 |
|
285 |
|
286 |
|
287 | <td class="description last"><p>Prouct we are running on. See
|
288 | <a href="module-sharedConstants.html">module:sharedConstants</a>. Default is to determine
|
289 | the product.</p></td>
|
290 | </tr>
|
291 |
|
292 |
|
293 |
|
294 | <tr>
|
295 |
|
296 | <td class="name"><code>port</code></td>
|
297 |
|
298 |
|
299 | <td class="type">
|
300 |
|
301 |
|
302 | <span class="param-type">Number</span>
|
303 |
|
304 |
|
305 |
|
306 | </td>
|
307 |
|
308 |
|
309 | <td class="attributes">
|
310 |
|
311 | <optional><br>
|
312 |
|
313 |
|
314 |
|
315 |
|
316 |
|
317 | </td>
|
318 |
|
319 |
|
320 |
|
321 |
|
322 | <td class="description last"><p>Port to connect to. Default 443.</p></td>
|
323 | </tr>
|
324 |
|
325 |
|
326 |
|
327 | <tr>
|
328 |
|
329 | <td class="name"><code>passwordIsUri</code></td>
|
330 |
|
331 |
|
332 | <td class="type">
|
333 |
|
334 |
|
335 | <span class="param-type">Boolean</span>
|
336 |
|
337 |
|
338 |
|
339 | </td>
|
340 |
|
341 |
|
342 | <td class="attributes">
|
343 |
|
344 | <optional><br>
|
345 |
|
346 |
|
347 |
|
348 |
|
349 |
|
350 | </td>
|
351 |
|
352 |
|
353 |
|
354 |
|
355 | <td class="description last"><p>Indicates that password is a URI for the password.</p></td>
|
356 | </tr>
|
357 |
|
358 |
|
359 |
|
360 | <tr>
|
361 |
|
362 | <td class="name"><code>passwordIsToken</code></td>
|
363 |
|
364 |
|
365 | <td class="type">
|
366 |
|
367 |
|
368 | <span class="param-type">Boolean</span>
|
369 |
|
370 |
|
371 |
|
372 | </td>
|
373 |
|
374 |
|
375 | <td class="attributes">
|
376 |
|
377 | <optional><br>
|
378 |
|
379 |
|
380 |
|
381 |
|
382 |
|
383 | </td>
|
384 |
|
385 |
|
386 |
|
387 |
|
388 | <td class="description last"><p>Indicates that the password is an auth token.</p></td>
|
389 | </tr>
|
390 |
|
391 |
|
392 |
|
393 | <tr>
|
394 |
|
395 | <td class="name"><code>passwordEncrypted</code></td>
|
396 |
|
397 |
|
398 | <td class="type">
|
399 |
|
400 |
|
401 | <span class="param-type">Boolean</span>
|
402 |
|
403 |
|
404 |
|
405 | </td>
|
406 |
|
407 |
|
408 | <td class="attributes">
|
409 |
|
410 | <optional><br>
|
411 |
|
412 |
|
413 |
|
414 |
|
415 |
|
416 | </td>
|
417 |
|
418 |
|
419 |
|
420 |
|
421 | <td class="description last"><p>Indicates that the password is encrypted.</p></td>
|
422 | </tr>
|
423 |
|
424 |
|
425 |
|
426 | <tr>
|
427 |
|
428 | <td class="name"><code>clOptions</code></td>
|
429 |
|
430 |
|
431 | <td class="type">
|
432 |
|
433 |
|
434 | <span class="param-type">Object</span>
|
435 |
|
436 |
|
437 |
|
438 | </td>
|
439 |
|
440 |
|
441 | <td class="attributes">
|
442 |
|
443 | <optional><br>
|
444 |
|
445 |
|
446 |
|
447 |
|
448 |
|
449 | </td>
|
450 |
|
451 |
|
452 |
|
453 |
|
454 | <td class="description last"><p>Command line options if called from a script.</p></td>
|
455 | </tr>
|
456 |
|
457 |
|
458 |
|
459 | <tr>
|
460 |
|
461 | <td class="name"><code>logger</code></td>
|
462 |
|
463 |
|
464 | <td class="type">
|
465 |
|
466 |
|
467 | <span class="param-type">Object</span>
|
468 |
|
469 |
|
470 |
|
471 | </td>
|
472 |
|
473 |
|
474 | <td class="attributes">
|
475 |
|
476 | <optional><br>
|
477 |
|
478 |
|
479 |
|
480 |
|
481 |
|
482 | </td>
|
483 |
|
484 |
|
485 |
|
486 |
|
487 | <td class="description last"><p>Logger to use. Or, pass loggerOptions to
|
488 | get your own logger.</p></td>
|
489 | </tr>
|
490 |
|
491 |
|
492 |
|
493 | <tr>
|
494 |
|
495 | <td class="name"><code>loggerOptions</code></td>
|
496 |
|
497 |
|
498 | <td class="type">
|
499 |
|
500 |
|
501 | <span class="param-type">Object</span>
|
502 |
|
503 |
|
504 |
|
505 | </td>
|
506 |
|
507 |
|
508 | <td class="attributes">
|
509 |
|
510 | <optional><br>
|
511 |
|
512 |
|
513 |
|
514 |
|
515 |
|
516 | </td>
|
517 |
|
518 |
|
519 |
|
520 |
|
521 | <td class="description last"><p>Options for the logger.
|
522 | See <a href="module-logger.html#.getLogger">module:logger.getLogger</a> for details.</p></td>
|
523 | </tr>
|
524 |
|
525 |
|
526 | </tbody>
|
527 | </table>
|
528 |
|
529 | </td>
|
530 | </tr>
|
531 |
|
532 |
|
533 | </tbody>
|
534 | </table>
|
535 |
|
536 |
|
537 |
|
538 |
|
539 |
|
540 |
|
541 | <dl class="details">
|
542 |
|
543 |
|
544 |
|
545 |
|
546 |
|
547 |
|
548 |
|
549 |
|
550 |
|
551 |
|
552 |
|
553 |
|
554 |
|
555 |
|
556 |
|
557 |
|
558 |
|
559 |
|
560 |
|
561 |
|
562 |
|
563 |
|
564 |
|
565 |
|
566 |
|
567 |
|
568 |
|
569 |
|
570 |
|
571 |
|
572 |
|
573 |
|
574 | </dl>
|
575 |
|
576 |
|
577 |
|
578 |
|
579 |
|
580 |
|
581 |
|
582 |
|
583 |
|
584 |
|
585 |
|
586 |
|
587 |
|
588 | <h5>Returns:</h5>
|
589 |
|
590 |
|
591 | <div class="param-desc">
|
592 | <p>A promise which is resolved with an iControl object to use
|
593 | for future requests or rejected if an error occurs.</p>
|
594 | </div>
|
595 |
|
596 |
|
597 |
|
598 | <dl>
|
599 | <dt>
|
600 | Type
|
601 | </dt>
|
602 | <dd>
|
603 |
|
604 | <span class="param-type">Promise</span>
|
605 |
|
606 |
|
607 | </dd>
|
608 | </dl>
|
609 |
|
610 |
|
611 |
|
612 |
|
613 |
|
614 |
|
615 |
|
616 |
|
617 |
|
618 |
|
619 |
|
620 |
|
621 |
|
622 | </article>
|
623 |
|
624 | </section>
|
625 |
|
626 |
|
627 |
|
628 |
|
629 | </div>
|
630 |
|
631 | <nav>
|
632 | <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-authn.html">authn</a></li><li><a href="module-bigIqLicenseProviderFactory.html">bigIqLicenseProviderFactory</a></li><li><a href="module-cryptoUtil.html">cryptoUtil</a></li><li><a href="module-httpUtil.html">httpUtil</a></li><li><a href="module-ipc.html">ipc</a></li><li><a href="module-localCryptoUtil.html">localCryptoUtil</a></li><li><a href="module-localKeyUtil.html">localKeyUtil</a></li><li><a href="module-logger.html">logger</a></li><li><a href="module-metricsCollector.html">metricsCollector</a></li><li><a href="module-sharedConstants.html">sharedConstants</a></li><li><a href="module-signals.html">signals</a></li><li><a href="module-util.html">util</a></li></ul><h3>Classes</h3><ul><li><a href="BigIp.html">BigIp</a></li><li><a href="BigIpCluster.html">BigIpCluster</a></li><li><a href="BigIpGtm.html">BigIpGtm</a></li><li><a href="BigIpOnboard.html">BigIpOnboard</a></li><li><a href="BigIq.html">BigIq</a></li><li><a href="BigIq50LicenseProvider.html">BigIq50LicenseProvider</a></li><li><a href="BigIq52LicenseProvider.html">BigIq52LicenseProvider</a></li><li><a href="BigIq53LicenseProvider.html">BigIq53LicenseProvider</a></li><li><a href="BigIq54LicenseProvider.html">BigIq54LicenseProvider</a></li><li><a href="CloudProvider.html">CloudProvider</a></li><li><a href="DnsProvider.html">DnsProvider</a></li><li><a href="GenericNodeProvider.html">GenericNodeProvider</a></li><li><a href="GtmDnsProvider.html">GtmDnsProvider</a></li><li><a href="IControl.html">IControl</a></li></ul><h3>Mixins</h3><ul><li><a href="bigIqClusterMixins.html">bigIqClusterMixins</a></li><li><a href="bigIqOnboardMixins.html">bigIqOnboardMixins</a></li></ul><h3>Global</h3><ul><li><a href="global.html#checkTask">checkTask</a></li><li><a href="global.html#forceResetUserPassword">forceResetUserPassword</a></li><li><a href="global.html#getDataFromPropPath">getDataFromPropPath</a></li><li><a href="global.html#getLicenseProvider">getLicenseProvider</a></li></ul>
|
633 | </nav>
|
634 |
|
635 | <br class="clear">
|
636 |
|
637 | <footer>
|
638 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
|
639 | </footer>
|
640 |
|
641 | <script> prettyPrint(); </script>
|
642 | <script src="scripts/linenumber.js"> </script>
|
643 | </body>
|
644 | </html> |
\ | No newline at end of file |