| |
| <!DOCTYPE HTML> |
| <html lang="" > |
| <head> |
| <meta charset="UTF-8"> |
| <title>Credentials · Eclipse Kapua™ User Guide</title> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge" /> |
| <meta name="description" content=""> |
| <meta name="generator" content="HonKit 3.6.20"> |
| |
| |
| |
| |
| <link rel="stylesheet" href="gitbook/style.css"> |
| |
| |
| |
| |
| <link rel="stylesheet" href="gitbook/gitbook-plugin-highlight/website.css"> |
| |
| |
| |
| <link rel="stylesheet" href="gitbook/gitbook-plugin-search/search.css"> |
| |
| |
| |
| <link rel="stylesheet" href="gitbook/gitbook-plugin-fontsettings/website.css"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <meta name="HandheldFriendly" content="true"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no"> |
| <meta name="apple-mobile-web-app-capable" content="yes"> |
| <meta name="apple-mobile-web-app-status-bar-style" content="black"> |
| <link rel="apple-touch-icon-precomposed" sizes="152x152" href="gitbook/images/apple-touch-icon-precomposed-152.png"> |
| <link rel="shortcut icon" href="gitbook/images/favicon.ico" type="image/x-icon"> |
| |
| |
| |
| <link rel="prev" href="mfa.html" /> |
| |
| |
| </head> |
| <body> |
| |
| <div class="book honkit-cloak"> |
| <div class="book-summary"> |
| |
| |
| <div id="book-search-input" role="search"> |
| <input type="text" placeholder="Type to search" /> |
| </div> |
| |
| |
| <nav role="navigation"> |
| |
| |
| |
| <ul class="summary"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="chapter " data-level="1.1" data-path="./"> |
| |
| <a href="./"> |
| |
| |
| Introduction |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.2" data-path="rest.html"> |
| |
| <a href="rest.html"> |
| |
| |
| REST API |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.3" data-path="community.html"> |
| |
| <a href="community.html"> |
| |
| |
| Community |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.4" data-path="simulator.html"> |
| |
| <a href="simulator.html"> |
| |
| |
| Simulator |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.5" data-path="jwt_security.html"> |
| |
| <a href="jwt_security.html"> |
| |
| |
| Setup JWT security |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.6" data-path="Permissions.html"> |
| |
| <a href="Permissions.html"> |
| |
| |
| Kapua Permissions |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter " data-level="1.7" data-path="mfa.html"> |
| |
| <a href="mfa.html"> |
| |
| |
| Multi Factor Authentication |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| <li class="chapter active" data-level="1.8" data-path="credentials.html"> |
| |
| <a href="credentials.html"> |
| |
| |
| Credentials |
| |
| </a> |
| |
| |
| |
| </li> |
| |
| |
| |
| |
| <li class="divider"></li> |
| |
| <li> |
| <a href="https://github.com/honkit/honkit" target="blank" class="gitbook-link"> |
| Published with HonKit |
| </a> |
| </li> |
| </ul> |
| |
| |
| </nav> |
| |
| |
| </div> |
| |
| <div class="book-body"> |
| |
| <div class="body-inner"> |
| |
| |
| |
| <div class="book-header" role="navigation"> |
| |
| |
| <!-- Title --> |
| <h1> |
| <i class="fa fa-circle-o-notch fa-spin"></i> |
| <a href="." >Credentials</a> |
| </h1> |
| </div> |
| |
| |
| |
| |
| <div class="page-wrapper" tabindex="-1" role="main"> |
| <div class="page-inner"> |
| |
| <div id="book-search-results"> |
| <div class="search-noresults"> |
| |
| <section class="normal markdown-section"> |
| |
| <h1 id="credentials">Credentials</h1> |
| <p>Any <strong>User</strong> can have <strong>Credentials</strong> of two types: <code>API_KEY</code> and <code>PASSWORD</code>.</p> |
| <p>An <code>API_KEY</code> credential consists of a random generated string, and will be shown only once during creation, so make sure |
| to write it down and keep somewhere safe as there will be no way to retrieve it. It can be used instead of the standard |
| <code>PASSWORD</code> <strong>Credential</strong> to perform a REST API login via the <code>/authentication/apikey</code> resource.</p> |
| <p>A <code>PASSWORD</code> credential is a standard password that is assigned to a <strong>User</strong>; only one <code>PASSWORD</code> <strong>Credential</strong> can |
| be assigned to a single <strong>User</strong>. By default, it must be at least 12 characters long and contain at least one uppercase |
| letter, one lowercase letter, one number and one symbol; however, a different minimum can be enforced both at account |
| level and at system level.</p> |
| <p>In order to set a different limit for a specific account, go to the <code>Child Accounts-->Settings</code> panel in the Console |
| and look for the <code>CredentialService</code> settings:</p> |
| <p><img src="images/credential_service_settings.png" alt="CredentialService Settings"></p> |
| <p>The <code>password.minLength</code> configuration value can be changed to enforce a different minimum length for new passwords; |
| existing passwords won't be affected by the change of the value. Allowed values are numbers between <code>12</code> and <code>255</code> |
| inclusive, or an empty value (default); in this case, the default system value will be used. In order to set the default |
| system value, use the <code>authentication.credential.userpass.password.minlength</code> system property; again, the allowed values |
| are numbers between <code>12</code> and <code>255</code> inclusive, with <code>12</code> being the default if no value is set. Setting a value lower than |
| <code>12</code> or higher than <code>255</code> will have the system reject the desired value and use <code>12</code> or <code>255</code> respectively.</p> |
| |
| |
| </section> |
| |
| </div> |
| <div class="search-results"> |
| <div class="has-results"> |
| |
| <h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1> |
| <ul class="search-results-list"></ul> |
| |
| </div> |
| <div class="no-results"> |
| |
| <h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1> |
| |
| </div> |
| </div> |
| </div> |
| |
| </div> |
| </div> |
| |
| </div> |
| |
| |
| |
| <a href="mfa.html" class="navigation navigation-prev navigation-unique" aria-label="Previous page: Multi Factor Authentication"> |
| <i class="fa fa-angle-left"></i> |
| </a> |
| |
| |
| |
| |
| </div> |
| |
| <script> |
| var gitbook = gitbook || []; |
| gitbook.push(function() { |
| gitbook.page.hasChanged({"page":{"title":"Credentials","level":"1.8","depth":1,"previous":{"title":"Multi Factor Authentication","level":"1.7","depth":1,"path":"mfa.md","ref":"mfa.md","articles":[]},"dir":"ltr"},"config":{"plugins":[],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"github":"eclipse/kapua","theme":"default","githubHost":"https://github.com/","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56},"embedFonts":false},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Eclipse Kapua™ User Guide","links":{"home":"http://eclipse.org/kapua"},"gitbook":"3.x.x","description":"Eclipse Kapua™ User Guide"},"file":{"path":"credentials.md","mtime":"2021-07-20T08:57:45.187Z","type":"markdown"},"gitbook":{"version":"3.6.20","time":"2021-07-20T08:58:21.032Z"},"basePath":".","book":{"language":""}}); |
| }); |
| </script> |
| </div> |
| |
| |
| <noscript> |
| <style> |
| .honkit-cloak { |
| display: block !important; |
| } |
| </style> |
| </noscript> |
| <script> |
| // Restore sidebar state as critical path for prevent layout shift |
| function __init__getSidebarState(defaultValue){ |
| var baseKey = ""; |
| var key = baseKey + ":sidebar"; |
| try { |
| var value = localStorage[key]; |
| if (value === undefined) { |
| return defaultValue; |
| } |
| var parsed = JSON.parse(value); |
| return parsed == null ? defaultValue : parsed; |
| } catch (e) { |
| return defaultValue; |
| } |
| } |
| function __init__restoreLastSidebarState() { |
| var isMobile = window.matchMedia("(max-width: 600px)").matches; |
| if (isMobile) { |
| // Init last state if not mobile |
| return; |
| } |
| var sidebarState = __init__getSidebarState(true); |
| var book = document.querySelector(".book"); |
| // Show sidebar if it enabled |
| if (sidebarState && book) { |
| book.classList.add("without-animation", "with-summary"); |
| } |
| } |
| |
| try { |
| __init__restoreLastSidebarState(); |
| } finally { |
| var book = document.querySelector(".book"); |
| book.classList.remove("honkit-cloak"); |
| } |
| </script> |
| <script src="gitbook/gitbook.js"></script> |
| <script src="gitbook/theme.js"></script> |
| |
| |
| <script src="gitbook/gitbook-plugin-search/search-engine.js"></script> |
| |
| |
| |
| <script src="gitbook/gitbook-plugin-search/search.js"></script> |
| |
| |
| |
| <script src="gitbook/gitbook-plugin-lunr/lunr.min.js"></script> |
| |
| |
| |
| <script src="gitbook/gitbook-plugin-lunr/search-lunr.js"></script> |
| |
| |
| |
| <script src="gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script> |
| |
| |
| |
| </body> |
| </html> |
| |
