{"id":9507,"date":"2024-05-13T06:45:39","date_gmt":"2024-05-13T06:45:39","guid":{"rendered":"https:\/\/accuweb.cloud\/api\/docs\/8-6-1\/quick-reference\/quick-start\/quickstart-authentication\/"},"modified":"2024-05-29T08:21:50","modified_gmt":"2024-05-29T08:21:50","slug":"quickstart-authentication","status":"publish","type":"docs","link":"https:\/\/accuweb.cloud\/api\/docs\/latest\/quick-reference\/quickstart-authentication\/","title":{"rendered":"Quickstart.Authentication"},"content":{"rendered":"\t\t<div data-elementor-type=\"wp-post\" data-elementor-id=\"9507\" class=\"elementor elementor-9507\" data-elementor-post-type=\"docs\">\n\t\t\t\t<div class=\"elementor-element elementor-element-2718ce9 e-flex e-con-boxed e-con e-parent\" data-id=\"2718ce9\" data-element_type=\"container\">\n\t\t\t\t\t<div class=\"e-con-inner\">\n\t\t\t\t<div class=\"elementor-element elementor-element-27934c4 elementor-widget elementor-widget-accordion\" data-id=\"27934c4\" data-element_type=\"widget\" data-widget_type=\"accordion.default\">\n\t\t\t\t<div class=\"elementor-widget-container\">\n\t\t\t<style>\/*! elementor - v3.23.0 - 05-08-2024 *\/\n.elementor-accordion{text-align:start}.elementor-accordion .elementor-accordion-item{border:1px solid #d5d8dc}.elementor-accordion .elementor-accordion-item+.elementor-accordion-item{border-top:none}.elementor-accordion .elementor-tab-title{margin:0;padding:15px 20px;font-weight:700;line-height:1;cursor:pointer;outline:none}.elementor-accordion .elementor-tab-title .elementor-accordion-icon{display:inline-block;width:1.5em}.elementor-accordion .elementor-tab-title .elementor-accordion-icon svg{width:1em;height:1em}.elementor-accordion .elementor-tab-title .elementor-accordion-icon.elementor-accordion-icon-right{float:right;text-align:right}.elementor-accordion .elementor-tab-title .elementor-accordion-icon.elementor-accordion-icon-left{float:left;text-align:left}.elementor-accordion .elementor-tab-title .elementor-accordion-icon .elementor-accordion-icon-closed{display:block}.elementor-accordion .elementor-tab-title .elementor-accordion-icon .elementor-accordion-icon-opened,.elementor-accordion .elementor-tab-title.elementor-active .elementor-accordion-icon-closed{display:none}.elementor-accordion .elementor-tab-title.elementor-active .elementor-accordion-icon-opened{display:block}.elementor-accordion .elementor-tab-content{display:none;padding:15px 20px;border-top:1px solid #d5d8dc}@media (max-width:767px){.elementor-accordion .elementor-tab-title{padding:12px 15px}.elementor-accordion .elementor-tab-title .elementor-accordion-icon{width:1.2em}.elementor-accordion .elementor-tab-content{padding:7px 15px}}.e-con-inner>.elementor-widget-accordion,.e-con>.elementor-widget-accordion{width:var(--container-widget-width);--flex-grow:var(--container-widget-flex-grow)}<\/style>\t\t<div class=\"elementor-accordion\">\n\t\t\t\t\t\t\t<div class=\"elementor-accordion-item\">\n\t\t\t\t\t<div id=\"elementor-tab-title-4141\" class=\"elementor-tab-title\" data-tab=\"1\" role=\"button\" aria-controls=\"elementor-tab-content-4141\" aria-expanded=\"false\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t<span class=\"elementor-accordion-icon elementor-accordion-icon-left\" aria-hidden=\"true\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<span class=\"elementor-accordion-icon-closed\"><svg class=\"e-font-icon-svg e-fas-plus\" viewBox=\"0 0 448 512\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\"><path d=\"M416 208H272V64c0-17.67-14.33-32-32-32h-32c-17.67 0-32 14.33-32 32v144H32c-17.67 0-32 14.33-32 32v32c0 17.67 14.33 32 32 32h144v144c0 17.67 14.33 32 32 32h32c17.67 0 32-14.33 32-32V304h144c17.67 0 32-14.33 32-32v-32c0-17.67-14.33-32-32-32z\"><\/path><\/svg><\/span>\n\t\t\t\t\t\t\t\t<span class=\"elementor-accordion-icon-opened\"><svg class=\"e-font-icon-svg e-fas-minus\" viewBox=\"0 0 448 512\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\"><path d=\"M416 208H32c-17.67 0-32 14.33-32 32v32c0 17.67 14.33 32 32 32h384c17.67 0 32-14.33 32-32v-32c0-17.67-14.33-32-32-32z\"><\/path><\/svg><\/span>\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t<\/span>\n\t\t\t\t\t\t\t\t\t\t\t\t<a class=\"elementor-accordion-title\" tabindex=\"0\">Signin<\/a>\n\t\t\t\t\t<\/div>\n\t\t\t\t\t<div id=\"elementor-tab-content-4141\" class=\"elementor-tab-content elementor-clearfix\" data-tab=\"1\" role=\"region\" aria-labelledby=\"elementor-tab-title-4141\"><h3>Signin (session,[appid], login, password ) :<\/h3>\nCreates a session for the specified user to authenticate different actions within the account. This session is valid until the\u00a0Signout\u00a0method is called or session has been expired.\n<h4>URL<\/h4>\nhttps:\/\/[hoster-api-host]\/1.0\/users\/authentication\/rest\/signin\n<h4>Parameters<\/h4>\n<ul>\n \t<li><span class=\"pre\"><b>session<\/b><\/span>\u00a0: &#8220;string&#8221;\n<div class=\"sub-desc\">\n\n<a class=\"wpil_keyword_link\" title=\"user session\" href=\"https:\/\/accuweb.cloud\/api\/docs\/8-6-1\/users\/authentication\/#signin-appid-login-password-authenticationresponse\" data-wpil-keyword-link=\"linked\" data-wpil-monitor-id=\"1203\">user session<\/a> or <a class=\"wpil_keyword_link\" title=\"personal access token\" href=\"https:\/\/accuweb.cloud\/api\/docs\/8-6-1\/others\/personal-access-tokens\/\" data-wpil-keyword-link=\"linked\" data-wpil-monitor-id=\"407\">personal access token<\/a>.\n\n<\/div><\/li>\n \t<li><b>appid<\/b>\u00a0: &#8220;string&#8221; (optional)\n<div>\n\nunique identifier of the target application (required for authentication).\n\n<\/div><\/li>\n \t<li><b>login<\/b>\u00a0: &#8220;string&#8221;\n<div>\n\nemail address or unique identifier of the target user.\n\n<\/div><\/li>\n \t<li><b>password<\/b>\u00a0: &#8220;string&#8221;\n<div>\n\npassword for authenticating the target user.\n\n<\/div><\/li>\n<\/ul>\n<h4>Example<\/h4>\n<span style=\"font-weight: bold;\">Method:<\/span>\u00a0POST\n\nPOST https:\/\/<a href=\"https:\/\/accuweb.cloud\/api\/docs\/8-6-1\/others\/user-environment-domain\/\" target=\"_blank\" rel=\"noopener\">[hoster-api-host]<\/a>\/1.0\/users\/authentication\/rest\/signin?password=[string]&amp;appid=[string]&amp;login=[string]\n<h4>Response<\/h4>\n<div>\n<pre>stdClass Object\n(\n    [result] =&gt; 0\n    [accessType] =&gt; \"FULL_ACCESS(0) | RESTRICTED(1)\"\n    [uid] =&gt; \"int\"\n    [debug] =&gt; stdClass Object\n        (\n            [cpu] =&gt; stdClass Object\n                (\n                    [usage] =&gt; 0\n                    [time] =&gt; 0\n                )\n            [time] =&gt; \"int\"\n        )\n    [data] =&gt; stdClass Object\n        (\n            [lang] =&gt; \"string\"\n        )\n    [authConfig] =&gt; stdClass Object\n        (\n            [type] =&gt; \"string\"\n        )\n    [session] =&gt; \"string\"\n    [email] =&gt; \"string\"\n    [status] =&gt; \"ENABLED(0) | SUSPENDED(1)\"\n)\n<\/pre>\n<\/div><\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t\t\t<div class=\"elementor-accordion-item\">\n\t\t\t\t\t<div id=\"elementor-tab-title-4142\" class=\"elementor-tab-title\" data-tab=\"2\" role=\"button\" aria-controls=\"elementor-tab-content-4142\" aria-expanded=\"false\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t<span class=\"elementor-accordion-icon elementor-accordion-icon-left\" aria-hidden=\"true\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<span class=\"elementor-accordion-icon-closed\"><svg class=\"e-font-icon-svg e-fas-plus\" viewBox=\"0 0 448 512\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\"><path d=\"M416 208H272V64c0-17.67-14.33-32-32-32h-32c-17.67 0-32 14.33-32 32v144H32c-17.67 0-32 14.33-32 32v32c0 17.67 14.33 32 32 32h144v144c0 17.67 14.33 32 32 32h32c17.67 0 32-14.33 32-32V304h144c17.67 0 32-14.33 32-32v-32c0-17.67-14.33-32-32-32z\"><\/path><\/svg><\/span>\n\t\t\t\t\t\t\t\t<span class=\"elementor-accordion-icon-opened\"><svg class=\"e-font-icon-svg e-fas-minus\" viewBox=\"0 0 448 512\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\"><path d=\"M416 208H32c-17.67 0-32 14.33-32 32v32c0 17.67 14.33 32 32 32h384c17.67 0 32-14.33 32-32v-32c0-17.67-14.33-32-32-32z\"><\/path><\/svg><\/span>\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t<\/span>\n\t\t\t\t\t\t\t\t\t\t\t\t<a class=\"elementor-accordion-title\" tabindex=\"0\">CreateToken<\/a>\n\t\t\t\t\t<\/div>\n\t\t\t\t\t<div id=\"elementor-tab-content-4142\" class=\"elementor-tab-content elementor-clearfix\" data-tab=\"2\" role=\"region\" aria-labelledby=\"elementor-tab-title-4142\"><h3>CreateToken (session, [password], description, [tokenTemplate], [apiList], [expiresAt] ) :<\/h3>\nCreates a <a title=\"personal access token\" href=\"https:\/\/accuweb.cloud\/api\/docs\/8-6-1\/others\/personal-access-tokens\/\" data-wpil-keyword-link=\"linked\" data-wpil-monitor-id=\"587\">personal access token<\/a>, which allows executing specific API methods.\n<h4>URL<\/h4>\nhttps:\/\/<a href=\"https:\/\/accuweb.cloud\/api\/docs\/8-6-1\/others\/user-environment-domain\/\" target=\"_blank\" rel=\"noopener\">[hoster-api-host]<\/a>\/1.0\/users\/authentication\/rest\/createtoken\n<h4>Request Parameters<\/h4>\n<ul>\n \t<li><b>session<\/b>\u00a0: &#8220;string&#8221;\n<div>\n<div class=\"sub-desc\">\n\n<a class=\"wpil_keyword_link\" title=\"user session\" href=\"https:\/\/accuweb.cloud\/api\/docs\/8-6-1\/users\/authentication\/#signin-appid-login-password-authenticationresponse\" data-wpil-keyword-link=\"linked\" data-wpil-monitor-id=\"1203\">user session<\/a> or <a class=\"wpil_keyword_link\" title=\"personal access token\" href=\"https:\/\/accuweb.cloud\/api\/docs\/8-6-1\/others\/personal-access-tokens\/\" data-wpil-keyword-link=\"linked\" data-wpil-monitor-id=\"407\">personal access token<\/a>.\n\n<\/div>\n<\/div><\/li>\n \t<li><b>password<\/b> : &#8220;string&#8221;\n<div>\n\npassword for authenticating the current user.\n\n<\/div><\/li>\n \t<li><b>description<\/b>\u00a0: &#8220;string&#8221;\n<div>\n\ncustom description for the created token.\n\n<\/div><\/li>\n \t<li><b>tokenTemplate\u00a0:<\/b> &#8220;string&#8221;\n<div>\n\none of standard tokens configurations with the predefined permissions (Marketplace, Maven Plugin, IDE Plugins, Extended Access). You can get the full list with the &#8220;GetTokenTemplates&#8221; method. If not specified, a &#8220;Custom&#8221; token with manually provided &#8220;apiList&#8221; will be created.\n\n<\/div><\/li>\n \t<li><b>apiList<\/b>\u00a0: &#8220;string&#8221;\n<div>\n\na comma-separated list of API methods that are allowed by the token. You can get the full list with the &#8220;GetTokenApiList&#8221; method. For example: [&#8220;env.control.CreateEnvironment&#8221;, &#8220;env.control.RedeployContainersByGroup&#8221;, &#8220;env.file.AddMountPointByGroup&#8221;].\n\n<\/div><\/li>\n \t<li><b>expiresAt<\/b>\u00a0: &#8220;string&#8221; (optional)\n<div>\n\nexpiration date (UTC) for the token. In the format \u201cyyyy-MM-dd hh:mm:ss\u201d, e.g. &#8220;2022-11-16 00:00:00&#8221;.\n\n<\/div><\/li>\n<\/ul>\n<h4>Example<\/h4>\n<span style=\"font-weight: bold;\">Method:<\/span>\u00a0POST\n\nhttps:\/\/<a href=\"https:\/\/accuweb.cloud\/api\/docs\/8-6-1\/others\/user-environment-domain\/\" target=\"_blank\" rel=\"noopener\">[hoster-api-host]<\/a>\/1.0\/users\/authentication\/rest\/createtoken?tokenTemplate=[string]&amp;password=[string]&amp;session=[string]&amp;description=[string]&amp;expiresAt=[string]&amp;apiList=[string]\n<h4>Response<\/h4>\n<div style=\"color: #425466; font-size: 16px;\">\n<pre>stdClass Object\n(\n    [result] =&gt; 0\n    [debug] =&gt; stdClass Object\n        (\n            [cpu] =&gt; stdClass Object\n                (\n                    [usage] =&gt; 0\n                    [time] =&gt; 0\n                )\n            [time] =&gt; \"int\"\n        )\n    [token] =&gt; stdClass Object\n        (\n            [tokenTemplate] =&gt; \"string\"\n            [description] =&gt; \"string\"\n            [id] =&gt; \"int\"\n            [createdOn] =&gt; \"Timestamp\"\n            [key] =&gt; \"string\"\n            [apiList] =&gt; Array\n                (\n                    [0] =&gt; \"API1\",\n                    [1] =&gt; \"API2\",\n                )\n        )\n)<\/pre>\n<\/div><\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t\t\t<div class=\"elementor-accordion-item\">\n\t\t\t\t\t<div id=\"elementor-tab-title-4143\" class=\"elementor-tab-title\" data-tab=\"3\" role=\"button\" aria-controls=\"elementor-tab-content-4143\" aria-expanded=\"false\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t<span class=\"elementor-accordion-icon elementor-accordion-icon-left\" aria-hidden=\"true\">\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t<span class=\"elementor-accordion-icon-closed\"><svg class=\"e-font-icon-svg e-fas-plus\" viewBox=\"0 0 448 512\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\"><path d=\"M416 208H272V64c0-17.67-14.33-32-32-32h-32c-17.67 0-32 14.33-32 32v144H32c-17.67 0-32 14.33-32 32v32c0 17.67 14.33 32 32 32h144v144c0 17.67 14.33 32 32 32h32c17.67 0 32-14.33 32-32V304h144c17.67 0 32-14.33 32-32v-32c0-17.67-14.33-32-32-32z\"><\/path><\/svg><\/span>\n\t\t\t\t\t\t\t\t<span class=\"elementor-accordion-icon-opened\"><svg class=\"e-font-icon-svg e-fas-minus\" viewBox=\"0 0 448 512\" xmlns=\"http:\/\/www.w3.org\/2000\/svg\"><path d=\"M416 208H32c-17.67 0-32 14.33-32 32v32c0 17.67 14.33 32 32 32h384c17.67 0 32-14.33 32-32v-32c0-17.67-14.33-32-32-32z\"><\/path><\/svg><\/span>\n\t\t\t\t\t\t\t\t\t\t\t\t\t\t<\/span>\n\t\t\t\t\t\t\t\t\t\t\t\t<a class=\"elementor-accordion-title\" tabindex=\"0\">GetUserInfo<\/a>\n\t\t\t\t\t<\/div>\n\t\t\t\t\t<div id=\"elementor-tab-content-4143\" class=\"elementor-tab-content elementor-clearfix\" data-tab=\"3\" role=\"region\" aria-labelledby=\"elementor-tab-title-4143\"><h3>GetUserInfo (appid, session ) :\u00a0<\/h3><p>Returns user information for the specified account.<\/p><h4 id=\"url\">URL<\/h4><p>https:\/\/<a href=\"https:\/\/accuweb.cloud\/api\/docs\/8-6-1\/others\/user-environment-domain\/\" target=\"_blank\" rel=\"noopener\">[hoster-api-host]<\/a>\/1.0\/users\/account\/rest\/getuserinfo<\/p><h4>Parameters<\/h4><ul><li><strong>appid\u00a0:<\/strong> &#8220;string&#8221;<div><p>unique identifier of the target application (required for authentication).<\/p><\/div><\/li><li><strong>session\u00a0:<\/strong> &#8220;string&#8221;<div><p><a title=\"user session\" href=\"https:\/\/accuweb.cloud\/api\/docs\/8-6-1\/users\/authentication\/#signin-appid-login-password-authenticationresponse\" data-wpil-keyword-link=\"linked\" data-wpil-monitor-id=\"1366\">user session<\/a> or <a title=\"personal access token\" href=\"https:\/\/accuweb.cloud\/api\/docs\/8-6-1\/others\/personal-access-tokens\/\" data-wpil-keyword-link=\"linked\" data-wpil-monitor-id=\"584\">personal access token<\/a>.<\/p><\/div><\/li><\/ul><h4>Example<\/h4><p><span style=\"font-weight: bold;\">Method:<\/span> POST<\/p><p>https:\/\/<a href=\"https:\/\/accuweb.cloud\/api\/docs\/8-6-1\/others\/user-environment-domain\/\" target=\"_blank\" rel=\"noopener\">[hoster-api-host]<\/a>\/1.0\/users\/account\/rest\/getuserinfo?session=[string]&amp;appid=[string]<\/p><h4>Response<\/h4><ul><li>AuthenticationResponse<div><pre>{\n   \"result\": \"int\",\n   \"accessType\": \"FULL_ACCESS(0) | RESTRICTED(1)\",\n   \"uid\": \"int\",\n   \"debug\": {\n       \"cpu\": {\n           \"usage\": \"string\",\n           \"time\": \"int\"\n       },\n       \"time\": \"int\"\n   },\n   \"data\": {\n       \"lang\": \"string\"\n   },\n   \"authConfig\": {\n       \"type\": \"string\"\n   },\n   \"email\": \"string\",\n   \"status\": \"ENABLED(0) | SUSPENDED(1)\",\n}\n<\/pre><\/div><\/li><\/ul><\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t\t\t<\/div>\n\t\t","protected":false},"excerpt":{"rendered":"<p>Signin Signin (session,[appid], login, password ) : Creates a session for the specified user to authenticate different actions within the account. This session is valid until the\u00a0Signout\u00a0method is called or session has been expired. URL https:\/\/[hoster-api-host]\/1.0\/users\/authentication\/rest\/signin Parameters session\u00a0: &#8220;string&#8221; user session or personal access token. appid\u00a0: &#8220;string&#8221; (optional) unique identifier of the target application (required [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":9376,"menu_order":1,"comment_status":"open","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"_links_to":"","_links_to_target":""},"doc_tag":[],"class_list":["post-9507","docs","type-docs","status-publish","hentry","no-post-thumbnail"],"acf":[],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/docs\/9507","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/comments?post=9507"}],"version-history":[{"count":5,"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/docs\/9507\/revisions"}],"predecessor-version":[{"id":9775,"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/docs\/9507\/revisions\/9775"}],"up":[{"embeddable":true,"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/docs\/9376"}],"wp:attachment":[{"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/media?parent=9507"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/accuweb.cloud\/api\/wp-json\/wp\/v2\/doc_tag?post=9507"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}