webgme-engine

<!DOCTYPE HTML><html><head><title>WebGME</title><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="generator" content="https://github.com/raml2html/raml2html 7.8.0"><link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/css/bootstrap.min.css"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/default.min.css"><script type="text/javascript" src="https://code.jquery.com/jquery-3.5.1.min.js"></script><script type="text/javascript" src="https://stackpath.bootstrapcdn.com/bootstrap/3.4.1/js/bootstrap.min.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script><script type="text/javascript"> $(document).ready(function() { $('.page-header pre code, .top-resource-description pre code, .modal-body pre code').each(function(i, block) { hljs.highlightBlock(block); }); $('[data-toggle]').click(function() { var selector = $(this).data('target') + ' pre code'; $(selector).each(function(i, block) { hljs.highlightBlock(block); }); }); // open modal on hashes like #_action_get $(window).bind('hashchange', function(e) { var anchor_id = document.location.hash.substr(1); //strip # var element = $('#' + anchor_id); // do we have such element + is it a modal? --> show it if (element.length && element.hasClass('modal')) { element.modal('show'); } }); // execute hashchange on first page load $(window).trigger('hashchange'); // remove url fragment on modal hide $('.modal').on('hidden.bs.modal', function() { try { if (history && history.replaceState) { history.replaceState({}, '', '#'); } } catch(e) {} }); }); </script><style> .hljs { background: transparent; } .parent { color: #999; } .list-group-item > .badge { float: none; margin-right: 6px; } .panel-title > .methods { float: right; } .badge { border-radius: 0; text-transform: uppercase; width: 70px; font-weight: normal; color: #f3f3f6; line-height: normal; } .badge_get { background-color: #63a8e2; } .badge_post { background-color: #6cbd7d; } .badge_put { background-color: #22bac4; } .badge_delete { background-color: #d26460; } .badge_patch { background-color: #ccc444; } .list-group, .panel-group { margin-bottom: 0; } .panel-group .panel+.panel-white { margin-top: 0; } .panel-group .panel-white { border-bottom: 1px solid #F5F5F5; border-radius: 0; } .panel-white:last-child { border-bottom-color: white; -webkit-box-shadow: none; box-shadow: none; } .panel-white .panel-heading { background: white; } .tab-pane ul { padding-left: 2em; } .tab-pane h1 { font-size: 1.3em; } .tab-pane h2 { font-size: 1.2em; padding-bottom: 4px; border-bottom: 1px solid #ddd; } .tab-pane h3 { font-size: 1.1em; } .tab-content { border-left: 1px solid #ddd; border-right: 1px solid #ddd; border-bottom: 1px solid #ddd; padding: 10px; } #sidebar { margin-top: 30px; padding-right: 5px; overflow: auto; height: 90%; } .top-resource-description { border-bottom: 1px solid #ddd; background: #fcfcfc; padding: 15px 15px 0 15px; margin: -15px -15px 10px -15px; } .resource-description { border-bottom: 1px solid #fcfcfc; background: #fcfcfc; padding: 15px 15px 0 15px; margin: -15px -15px 10px -15px; } .resource-description p:last-child { margin: 0; } .list-group .badge { float: left; } .method_description { margin-left: 85px; } .method_description p:last-child { margin: 0; } .list-group-item { cursor: pointer; } .list-group-item:hover { background-color: #f5f5f5; } pre code { overflow: auto; word-wrap: normal; white-space: pre; } .items { background: #f5f5f5; color: #333; border: 1px solid #ccc; border-radius: 4px; padding: 9.5px; margin: 0 0 10px; font-size: 13px; line-height: 1.42857143; } .examples { margin-left: 0.5em; } .resource-modal li > ul { margin-bottom: 1em; } .required { color: #f00; } </style></head><body data-spy="scroll" data-target="#sidebar"><div class="container"><div class="row"><div class="col-md-9" role="main"><div class="page-header"><h1>WebGME <small>version 1.0</small></h1><p></p></div><div class="panel panel-default"><div class="panel-heading"><h3 class="panel-title">/</h3></div><div class="panel-body"><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_"><span class="parent"></span>/</a> <span class="methods"><a href="#_get"><span class="badge badge_get">get</span></a></span></h4></div><div id="panel_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#_get'" class="list-group-item"><span class="badge badge_get">get</span><div class="method_description"><p>WebGME API entry point</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get</span> <span class="parent"></span>/</h4></div><div class="modal-body"><div class="alert alert-info"><p>WebGME API entry point</p></div><ul class="nav nav-tabs"><li class="active"><a href="#_get_response" data-toggle="tab">Response</a></li></ul><div class="tab-content"><div class="tab-pane active" id="_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{ "current_user_url": "http://localhost:8888/api/user", "organization_url": "http://localhost:8888/api/orgs/{org}", "project_url": "http://localhost:8888/api/projects/{owner}/{project}", "user_url": "http://localhost:8888/api/users/{user}", "documentation_url": "http://localhost:8888/developer/api" }</code></pre></div></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="componentsettings" class="panel-title">/componentSettings</h3></div><div class="panel-body"><div class="top-resource-description"><p>End points for default deployment settings.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_componentsettings"><span class="parent"></span>/componentSettings</a> <span class="methods"><a href="#componentsettings_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_componentsettings" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#componentsettings_get'" class="list-group-item"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns all component settings defined for the deployment, see <a href="https://github.com/webgme/webgme/wiki/Component-Settings">https://github.com/webgme/webgme/wiki/Component-Settings</a></p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="componentsettings_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/componentSettings</h4></div><div class="modal-body"><div class="alert alert-info"><p>Returns all component settings defined for the deployment, see <a href="https://github.com/webgme/webgme/wiki/Component-Settings">https://github.com/webgme/webgme/wiki/Component-Settings</a></p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>basic</b><p>Basic authentication scheme</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>bearer</b><p>JWT Bearer with authentication token.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#componentsettings_get_response" data-toggle="tab">Response</a></li><li><a href="#componentsettings_get_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="componentsettings_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{ "Plugin_ConfigurationArtifact__0_1_0": { "species": "Horsie", "age": 3, "carnivore": false, "classification": "Vertebrates", "color": "#FF0000", "file": "" }, "ICorePanel": { "consoleWindow": { "logLevel": "info", "verticalOrientation": false } } }</code></pre></div></div><div class="tab-pane" id="componentsettings_get_securedby"><h1>Secured by basic</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Basic authentication base64 encoded username and password</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Basic Z3Vlc3Q6Z3Vlc3Q=</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p><h1>Secured by bearer</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Token Bearer</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_componentsettings__componentid_"><span class="parent">/componentSettings</span>/{componentId}</a> <span class="methods"><a href="#componentsettings__componentid__get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_componentsettings__componentid_" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#componentsettings__componentid__get'" class="list-group-item"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns a specific component settings defined for the deployment, see <a href="https://github.com/webgme/webgme/wiki/Component-Settings">https://github.com/webgme/webgme/wiki/Component-Settings</a></p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="componentsettings__componentid__get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/componentSettings</span>/{componentId}</h4></div><div class="modal-body"><div class="alert alert-info"><p>Returns a specific component settings defined for the deployment, see <a href="https://github.com/webgme/webgme/wiki/Component-Settings">https://github.com/webgme/webgme/wiki/Component-Settings</a></p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>basic</b><p>Basic authentication scheme</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>bearer</b><p>JWT Bearer with authentication token.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#componentsettings__componentid__get_request" data-toggle="tab">Request</a></li><li><a href="#componentsettings__componentid__get_response" data-toggle="tab">Response</a></li><li><a href="#componentsettings__componentid__get_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="componentsettings__componentid__get_request"><h3>URI Parameters</h3><ul><li><strong>componentId</strong>: <em><span class="required">required</span>(string)</em></li></ul></div><div class="tab-pane" id="componentsettings__componentid__get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{ "consoleWindow": { "logLevel": "info", "verticalOrientation": false } }</code></pre></div></div><div class="tab-pane" id="componentsettings__componentid__get_securedby"><h1>Secured by basic</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Basic authentication base64 encoded username and password</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Basic Z3Vlc3Q6Z3Vlc3Q=</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p><h1>Secured by bearer</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Token Bearer</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p></div></div></div></div></div></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h3 id="user" class="panel-title">/user</h3></div><div class="panel-body"><div class="top-resource-description"><p>End points for currently connected user.</p></div><div class="panel-group"><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_user"><span class="parent"></span>/user</a> <span class="methods"><a href="#user_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#user_delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_user" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#user_get'" class="list-group-item"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Returns with the current user</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#user_delete'" class="list-group-item"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Remove the current user</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="user_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/user</h4></div><div class="modal-body"><div class="alert alert-info"><p>Returns with the current user</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>basic</b><p>Basic authentication scheme</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>bearer</b><p>JWT Bearer with authentication token.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#user_get_response" data-toggle="tab">Response</a></li><li><a href="#user_get_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="user_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{ "_id": "demo", "email": "a@example.com", "canCreate": true, "projects": { "guest+aaaaaa": { "read": true, "write": true, "delete": false }, "demo+ASDF": { "read": true, "write": true, "delete": true } }, "orgs": [ "ATeam" ], "siteAdmin": true, "data": {} }</code></pre></div></div><div class="tab-pane" id="user_get_securedby"><h1>Secured by basic</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Basic authentication base64 encoded username and password</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Basic Z3Vlc3Q6Z3Vlc3Q=</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p><h1>Secured by bearer</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Token Bearer</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="user_delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent"></span>/user</h4></div><div class="modal-body"><div class="alert alert-info"><p>Remove the current user</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>basic</b><p>Basic authentication scheme</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>bearer</b><p>JWT Bearer with authentication token.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#user_delete_response" data-toggle="tab">Response</a></li><li><a href="#user_delete_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="user_delete_response"><h2>HTTP status code <a href="http://httpstatus.es/204" target="_blank">204</a></h2></div><div class="tab-pane" id="user_delete_securedby"><h1>Secured by basic</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Basic authentication base64 encoded username and password</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Basic Z3Vlc3Q6Z3Vlc3Q=</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p><h1>Secured by bearer</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Token Bearer</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_user_token"><span class="parent">/user</span>/token</a> <span class="methods"><a href="#user_token_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_user_token" class="panel-collapse collapse"><div class="panel-body"><div class="list-group"><div onclick="window.location.href = '#user_token_get'" class="list-group-item"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Creates and returns a token for the user</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="user_token_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/user</span>/token</h4></div><div class="modal-body"><div class="alert alert-info"><p>Creates and returns a token for the user</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>basic</b><p>Basic authentication scheme</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>bearer</b><p>JWT Bearer with authentication token.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#user_token_get_response" data-toggle="tab">Response</a></li><li><a href="#user_token_get_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="user_token_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{ "webgmeToken": "eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38" }</code></pre></div></div><div class="tab-pane" id="user_token_get_securedby"><h1>Secured by basic</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Basic authentication base64 encoded username and password</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Basic Z3Vlc3Q6Z3Vlc3Q=</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p><h1>Secured by bearer</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Token Bearer</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_user_data"><span class="parent">/user</span>/data</a> <span class="methods"><a href="#user_data_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#user_data_put"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#user_data_patch"><span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#user_data_delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_user_data" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Entity representing a datum. Nested values can be accessed via URI parameters such as <code>/user/data/key1/key2...</code>.</p></div><div class="list-group"><div onclick="window.location.href = '#user_data_get'" class="list-group-item"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Get the datum. The user data field is an arbitrary object where developers can put custom data associated with a specific user. For preferences consider using settings instead, which provides options for server defaults.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#user_data_put'" class="list-group-item"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Add a new datum to WebGME. Overwrites the data field.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#user_data_patch'" class="list-group-item"><span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Update datum within WebGME. Updates/overwrites the user's data with the sent values for matching keys.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#user_data_delete'" class="list-group-item"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Delete datum from WebGME. Clears out the user's data field (sets it to empty dictionary).</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="user_data_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/user</span>/data</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get the datum. The user data field is an arbitrary object where developers can put custom data associated with a specific user. For preferences consider using settings instead, which provides options for server defaults.</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>basic</b><p>Basic authentication scheme</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>bearer</b><p>JWT Bearer with authentication token.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#user_data_get_request" data-toggle="tab">Request</a></li><li><a href="#user_data_get_response" data-toggle="tab">Response</a></li><li><a href="#user_data_get_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="user_data_get_request"><h3>Query Parameters</h3><ul><li><strong>decrypt</strong>: <em>(boolean)</em><p>Decrypt the requested data.</p></li></ul></div><div class="tab-pane" id="user_data_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{ "country": "USA", "organization": "Org", "name": "Joe Smith" } </code></pre></div><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{ "message": "datum not found" }</code></pre></div></div><div class="tab-pane" id="user_data_get_securedby"><h1>Secured by basic</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Basic authentication base64 encoded username and password</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Basic Z3Vlc3Q6Z3Vlc3Q=</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p><h1>Secured by bearer</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Token Bearer</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="user_data_put"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/user</span>/data</h4></div><div class="modal-body"><div class="alert alert-info"><p>Add a new datum to WebGME. Overwrites the data field.</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>basic</b><p>Basic authentication scheme</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>bearer</b><p>JWT Bearer with authentication token.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#user_data_put_request" data-toggle="tab">Request</a></li><li><a href="#user_data_put_response" data-toggle="tab">Response</a></li><li><a href="#user_data_put_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="user_data_put_request"><h3>Query Parameters</h3><ul><li><strong>encrypt</strong>: <em>(boolean)</em><p>Encrypt the submitted data before saving.</p></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{ "country": "USA", "organization": "Org", "name": "Joe Smith" } </code></pre></div></div><div class="tab-pane" id="user_data_put_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{ "country": "USA", "organization": "Org", "name": "Joe Smith" }</code></pre></div><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2></div><div class="tab-pane" id="user_data_put_securedby"><h1>Secured by basic</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Basic authentication base64 encoded username and password</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Basic Z3Vlc3Q6Z3Vlc3Q=</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p><h1>Secured by bearer</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Token Bearer</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="user_data_patch"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/user</span>/data</h4></div><div class="modal-body"><div class="alert alert-info"><p>Update datum within WebGME. Updates/overwrites the user's data with the sent values for matching keys.</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>basic</b><p>Basic authentication scheme</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>bearer</b><p>JWT Bearer with authentication token.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#user_data_patch_request" data-toggle="tab">Request</a></li><li><a href="#user_data_patch_response" data-toggle="tab">Response</a></li><li><a href="#user_data_patch_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="user_data_patch_request"><h3>Query Parameters</h3><ul><li><strong>encrypt</strong>: <em>(boolean)</em><p>Encrypt the submitted data before saving.</p></li></ul><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{ "country": "USA" } </code></pre></div></div><div class="tab-pane" id="user_data_patch_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{ "country": "USA", "organization": "Org", "name": "Joe Smith" }</code></pre></div><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2></div><div class="tab-pane" id="user_data_patch_securedby"><h1>Secured by basic</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Basic authentication base64 encoded username and password</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Basic Z3Vlc3Q6Z3Vlc3Q=</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p><h1>Secured by bearer</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Token Bearer</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p></div></div></div></div></div></div><div class="modal fade" tabindex="0" id="user_data_delete"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/user</span>/data</h4></div><div class="modal-body"><div class="alert alert-info"><p>Delete datum from WebGME. Clears out the user's data field (sets it to empty dictionary).</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>basic</b><p>Basic authentication scheme</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>bearer</b><p>JWT Bearer with authentication token.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#user_data_delete_request" data-toggle="tab">Request</a></li><li><a href="#user_data_delete_response" data-toggle="tab">Response</a></li><li><a href="#user_data_delete_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="user_data_delete_request"><h3>Query Parameters</h3><ul><li><strong>force</strong>: <em>(boolean)</em><p>If true and <b>user.siteAdmin</b> user will be deleted from database</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>true</code></pre></div></li></ul></div><div class="tab-pane" id="user_data_delete_response"><h2>HTTP status code <a href="http://httpstatus.es/204" target="_blank">204</a></h2><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2></div><div class="tab-pane" id="user_data_delete_securedby"><h1>Secured by basic</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Basic authentication base64 encoded username and password</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Basic Z3Vlc3Q6Z3Vlc3Q=</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p><h1>Secured by bearer</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Token Bearer</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p></div></div></div></div></div></div></div><div class="panel panel-white resource-modal"><div class="panel-heading"><h4 class="panel-title"><a class="collapsed" data-toggle="collapse" href="#panel_user_settings"><span class="parent">/user</span>/settings</a> <span class="methods"><a href="#user_settings_get"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#user_settings_put"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#user_settings_patch"><span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a> <a href="#user_settings_delete"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span></a></span></h4></div><div id="panel_user_settings" class="panel-collapse collapse"><div class="panel-body"><div class="resource-description"><p>Entity representing a setting</p></div><div class="list-group"><div onclick="window.location.href = '#user_settings_get'" class="list-group-item"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Get the setting. Gets all component-settings for a user, see <a href="https://github.com/webgme/webgme/wiki/Component-Settings">https://github.com/webgme/webgme/wiki/Component-Settings</a></p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#user_settings_put'" class="list-group-item"><span class="badge badge_put">put <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Add a new setting to WebGME. Overwrites the settings field.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#user_settings_patch'" class="list-group-item"><span class="badge badge_patch">patch <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Update setting within WebGME. Updates/overwrites the user's settings with the sent values for matching keys.</p></div><div class="clearfix"></div></div><div onclick="window.location.href = '#user_settings_delete'" class="list-group-item"><span class="badge badge_delete">delete <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span><div class="method_description"><p>Delete setting from WebGME. Clears out the user's settings field (sets it to empty dictionary).</p></div><div class="clearfix"></div></div></div></div></div><div class="modal fade" tabindex="0" id="user_settings_get"><div class="modal-dialog modal-lg"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">×</button><h4 class="modal-title" id="myModalLabel"><span class="badge badge_get">get <span class="glyphicon glyphicon-lock" title="Authentication required"></span></span> <span class="parent">/user</span>/settings</h4></div><div class="modal-body"><div class="alert alert-info"><p>Get the setting. Gets all component-settings for a user, see <a href="https://github.com/webgme/webgme/wiki/Component-Settings">https://github.com/webgme/webgme/wiki/Component-Settings</a></p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>basic</b><p>Basic authentication scheme</p></div><div class="alert alert-warning"><span class="glyphicon glyphicon-lock" title="Authentication required"></span> Secured by <b>bearer</b><p>JWT Bearer with authentication token.</p></div><ul class="nav nav-tabs"><li class="active"><a href="#user_settings_get_response" data-toggle="tab">Response</a></li><li><a href="#user_settings_get_securedby" data-toggle="tab">Security</a></li></ul><div class="tab-content"><div class="tab-pane active" id="user_settings_get_response"><h2>HTTP status code <a href="http://httpstatus.es/200" target="_blank">200</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{ "Plugin_ConfigurationArtifact__0_1_0": { "species":"Horsie", "age":3, "carnivore":false, "classification":"Vertebrates", "color":"#FF0000", "file":"" }, "ICorePanel":{ "consoleWindow":{ "logLevel": "info", "verticalOrientation":false } } } </code></pre></div><h2>HTTP status code <a href="http://httpstatus.es/404" target="_blank">404</a></h2><h3>Body</h3><p><strong>Media type</strong>: application/json</p><p><strong>Type</strong>: any</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>{ "message": "setting not found" }</code></pre></div></div><div class="tab-pane" id="user_settings_get_securedby"><h1>Secured by basic</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Basic authentication base64 encoded username and password</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Basic Z3Vlc3Q6Z3Vlc3Q=</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p><h1>Secured by bearer</h1><h3>Headers</h3><ul><li><strong>Authorization</strong>: <em><span class="required">required</span>(string)</em><p>Token Bearer</p><p><strong>Example</strong>:</p><div class="examples"><pre><code>Bearer eyJhbGcjOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJkZW1vIiwiaWF0IjoxNDg3NjEyNjE0LCJleHAiOjE0ODgyMTc0MTR9.LAuYXXa4tQhLD1sUQl1MHZFwkaf6ua7_aA62WXFNAMEN-11tlmM576e5JuoE2KqxvoN2v8PZNXgPmL0vMpKSLc6orxnl5o6YABWGTCBPtbad-iAXnkm79MeQrRceYe3nW-Lhc9_PM6bJ3ftrtrmEUwtOL1bV6nhyBU4ICTE7m38</code></pre></div></li></ul><h2>HTTP status code <a href="http://httpstatus.es/401" target="_blank">401</a></h2><p>Authentication required</p><h2>HTTP status code <a href="http://httpstatus.es/403" target="_blank">403</a></h2><p>Forbidden</p></div></div></div></div></div></d