hmLoadTopic({
hmKeywords:"",
hmTitle:"ApiKeys",
hmDescription:"Valid for ApiKey Authentication Mode only. Through an API Key, a operation is authenticated and authorized. The value pair x-api-key: \"yourapikey\" must be included In the body o",
hmPrevLink:"ws_api-resources.html",
hmNextLink:"ws_standard-claims.html",
hmParentLink:"ws_manager.html",
hmBreadCrumbs:"<a href=\"ws_manager.html\">LinkarWS Manager<\/a>",
hmTitlePath:"LinkarWS Manager > ApiKeys",
hmHeader:"<h1 class=\"p_Heading1\" style=\"page-break-after: avoid;\"><span class=\"f_Heading1\">ApiKeys<\/span><\/h1>\n\r",
hmBody:"<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-weight: bold;\">Valid for ApiKey Authentication Mode only.<\/span><\/p>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Through an API Key, a operation is authenticated and authorized. The value pair x-api-key: &quot;yourapikey&quot; must be included In the body of the request.<\/p>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">More information on this<span style=\"font-weight: bold; background-color: #ffffff;\">&nbsp;<\/span><span style=\"background-color: #ffffff;\"><a href=\"ws_apikey.html\" class=\"topiclink\">link<\/a><\/span><\/p>\n\r<p style=\"text-align: center; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><img style=\"margin:0 auto 0 auto;width:63.3750rem;height:35.2500rem;border:none\" src=\".\/images\/apikeyslist.png\"\/><\/p>\n\r<div style=\"text-align: center; text-indent: 0; padding: 0 0 0 0; margin: 0 0 0 0;\"><table class=\"argumentos\" >\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-weight: bold;\">Field<\/span><\/p>\n\r<\/td>\n\r<td class=\"argumentos\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-weight: bold;\">Type<\/span><\/p>\n\r<\/td>\n\r<td class=\"argumentos\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-weight: bold;\">Description<\/span><\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">New<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">Button<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">Create an ApiKey.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">Delete Selected<\/p>\n\r<\/td>\n\r<td class=\"argumentos\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">Button<\/p>\n\r<\/td>\n\r<td class=\"argumentos\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">Delete selected ApiKeys from the Database.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Export Selected<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">Button<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">Export selected ApiKeys to a JSON file.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Import from file<\/p>\n\r<\/td>\n\r<td class=\"argumentos\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">Button<\/p>\n\r<\/td>\n\r<td class=\"argumentos\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">Import ApiKeys from a JSON file.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Pencil Icon <\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">Button<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">Edit the ApiKey.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Trash Icon<\/p>\n\r<\/td>\n\r<td class=\"argumentos\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">Button<\/p>\n\r<\/td>\n\r<td class=\"argumentos\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">Delete the ApiKey.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Copy Icon<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">Button<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">Create an ApiKey by copying data from an existing ApiKey.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<\/table>\n\r<\/div>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-size: 0.91rem; color: #000000;\">&nbsp;<\/span><\/p>\n\r<p class=\"p_HeadingHowTo_atoc_\" style=\"page-break-after: avoid;\"><img style=\"margin:0;width:1.0000rem;height:1.0000rem;border:none\" src=\".\/images\/tog_plus.gif\"\/><span class=\"f_HeadingHowTo_atoc_\" style=\"font-size: 1.00rem; font-family: Arial,Helvetica,sans-serif;\">Create\/Edit\/Copy API Key <\/span><\/p>\n\r<div style=\"text-align: left; padding: 0 0 0 0; margin: 0 0 0 2.0000rem;\"><table style=\"border:none; border-spacing:0;\">\n\r<tr>\n\r<td style=\"vertical-align:top; padding:0; border:none\"><div style=\"text-align: center; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><div style=\"margin:0 auto 0 auto;width:80%;max-width:1541px;height:auto;\"><img style=\"width:100%;height:auto;border:none\" src=\".\/images\/apikeys.png\"\/><\/div><\/div>\n\r<p class=\"p_Normal\">. <\/p>\n\r<div style=\"text-align: left; text-indent: 0; padding: 0 0 0 0; margin: 0 0 0 0;\"><table class=\"argumentos\" >\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-weight: bold;\">Campo<\/span><\/p>\n\r<\/td>\n\r<td class=\"argumentos\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-weight: bold;\">Tipo<\/span><\/p>\n\r<\/td>\n\r<td class=\"argumentos\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-weight: bold;\">Descripción<\/span><\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Cancel<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Button<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Discard changes and close the form.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Create\/Update<\/p>\n\r<\/td>\n\r<td class=\"argumentos\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Button<\/p>\n\r<\/td>\n\r<td class=\"argumentos\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Save the ApiKey<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">x-api-key<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Required<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">ApiKey code passed in the request with the value pair x-api-key: &quot;yourapikey&quot;.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Expiration Date<\/p>\n\r<\/td>\n\r<td class=\"argumentos\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Optional<\/p>\n\r<\/td>\n\r<td class=\"argumentos\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">ApiKey expiration date.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Enabled<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Switch<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Enables\/Disables the ApiKey.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Swagger Description<\/p>\n\r<\/td>\n\r<td class=\"argumentos\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Optional<\/p>\n\r<\/td>\n\r<td class=\"argumentos\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">Description shown in the Swagger.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Internal Description<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Optional<\/p>\n\r<\/td>\n\r<td class=\"argumentos\" style=\"background-color:#CCFFFF;\"><p style=\"line-height: 1.28; margin: 0 0 0.6875rem 0;\">Description shown in the documentation.<\/p>\n\r<\/td>\n\r<\/tr>\n\r<tr class=\"argumentos\">\n\r<td class=\"argumentos\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Allowed IPs<\/p>\n\r<\/td>\n\r<td class=\"argumentos\"><p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Optional<\/p>\n\r<\/td>\n\r<td class=\"argumentos\"><p style=\"text-align: justify; line-height: 1.28;\">Allowed source IPs or DNS to execute operations in this API Key.<\/p>\n\r<p style=\"text-align: justify; line-height: 1.28;\">You can specify IP\'s or IP Range separated by hyphen.<\/p>\n\r<p style=\"text-align: justify; line-height: 1.28;\">If you want to indicate a DNS you must indicate as prefix &quot;dns&quot;<\/p>\n\r<p style=\"text-align: justify; line-height: 1.28;\"><span style=\"font-size: 0.91rem; color: #000000;\">&nbsp;<\/span><\/p>\n\r<p style=\"text-align: justify; line-height: 1.28;\">Examples:<\/p>\n\r<p style=\"text-align: justify; line-height: 1.28;\">192.168.0.100<\/p>\n\r<p style=\"text-align: justify; line-height: 1.28;\">192.168.0.0-192.168.0.254<\/p>\n\r<p style=\"text-align: justify; line-height: 1.28;\">dns:mydomain.com<\/p>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-size: 0.91rem; color: #000000;\">&nbsp;<\/span><\/p>\n\r<\/td>\n\r<\/tr>\n\r<\/table>\n\r<\/div>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-size: 0.91rem; color: #000000;\">&nbsp;<\/span><\/p>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\">Each API Key will be able to execute a certain selection of defined Scopes. It is mandatory to indicate which Scopes are enabled for the API Key. From the Select Scopes select you will be able to add one or more available Scopes from one or more ApiResources. <\/p>\n\r<div style=\"text-align: center; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><div style=\"margin:0 auto 0 auto;width:100%;height:auto;\"><img style=\"width:100%;height:auto;border:none\" src=\".\/images\/apikeys2.png\"\/><\/div><\/div>\n\r<p class=\"p_Normal\" style=\"text-align: justify; margin: 0 0 0 1.5000rem;\">&nbsp;<\/p>\n\r<\/td>\n\r<\/tr>\n\r<\/table>\n\r<\/div>\n\r<p class=\"p_Normal\">&nbsp;<\/p>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-size: 0.91rem; color: #000000;\">&nbsp;<\/span><\/p>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-size: 0.91rem; color: #000000;\">&nbsp;<\/span><\/p>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-size: 0.91rem; color: #000000;\">&nbsp;<\/span><\/p>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-size: 0.91rem; color: #000000;\">&nbsp;<\/span><\/p>\n\r<p style=\"text-align: justify; line-height: 1.28; margin: 0 0 0.6875rem 0;\"><span style=\"font-size: 0.91rem; color: #000000;\">&nbsp;<\/span><\/p>\n\r"
})
