This gist is associated with this question on SO: https://stackoverflow.com/questions/49381576/json-validation-error-with-html-content

sample.json

{
	"title": "",
	"content": "<div id=\"header\"><h1>User Management Micro-Service API Design Specifications<\/h1><div id=\"toc\" class=\"toc2\"><div id=\"toctitle\">Table of Contents<\/div><ul class=\"sectlevel1\"><li><a href=\"#_overview\">1. Overview<\/a><ul class=\"sectlevel2\"><li><a href=\"#_version_information\">1.1. Version information<\/a><\/li><li><a href=\"#_uri_scheme\">1.2. URI scheme<\/a><\/li><li><a href=\"#_tags\">1.3. Tags<\/a><\/li><li><a href=\"#_produces\">1.4. Produces<\/a><\/li><\/ul><\/li><li><a href=\"#_paths\">2. Resources<\/a><ul class=\"sectlevel2\"><li><a href=\"#_login_resource\">2.1. Login<\/a><\/li><li><a href=\"#_user_resource\">2.2. User<\/a><\/li><li><a href=\"#_microservice_resource\">2.3. Microservice<\/a><\/li><li><a href=\"#_role_resource\">2.4. Role<\/a><\/li><li><a href=\"#_permission_resource\">2.5. Permission<\/a><\/li><\/ul><\/li><li><a href=\"#_definitions\">3. Definitions<\/a><ul class=\"sectlevel2\"><li><a href=\"#_401out\">3.1. 401Out<\/a><\/li><li><a href=\"#_error\">3.2. Error<\/a><\/li><li><a href=\"#_addremoveroles\">3.3. addRemoveRoles<\/a><\/li><li><a href=\"#_addrevokepermissions\">3.4. addRevokePermissions<\/a><\/li><li><a href=\"#_addrevokeuser\">3.5. addRevokeUser<\/a><\/li><li><a href=\"#_createmicroservice\">3.6. createMicroservice<\/a><\/li><li><a href=\"#_createpermission\">3.7. createPermission<\/a><\/li><li><a href=\"#_createrole\">3.8. createRole<\/a><\/li><li><a href=\"#_errorformat\">3.9. errorFormat<\/a><\/li><li><a href=\"#_idinput\">3.10. idInput<\/a><\/li><li><a href=\"#_messageoutput\">3.11. messageOutput<\/a><\/li><li><a href=\"#_messageoutputarray\">3.12. messageOutputArray<\/a><\/li><li><a href=\"#_microservice\">3.13. microService<\/a><\/li><li><a href=\"#_microserviceoutput\">3.14. microserviceOutput<\/a><\/li><li><a href=\"#_microserviceshowoutput\">3.15. microserviceShowOutput<\/a><\/li><li><a href=\"#_multiroles\">3.16. multiRoles<\/a><\/li><li><a href=\"#_newuser\">3.17. newUser<\/a><\/li><li><a href=\"#_permoutput\">3.18. permOutput<\/a><\/li><li><a href=\"#_permshowoutput\">3.19. permShowOutput<\/a><\/li><li><a href=\"#_permission\">3.20. permission<\/a><\/li><li><a href=\"#_resetpassword\">3.21. resetPassword<\/a><\/li><li><a href=\"#_responsecreateuser\">3.22. responseCreateUser<\/a><\/li><li><a href=\"#_role\">3.23. role<\/a><\/li><li><a href=\"#_roleoutput\">3.24. roleOutput<\/a><\/li><li><a href=\"#_roleshowoutput\">3.25. roleShowOutput<\/a><\/li><li><a href=\"#_roleupdate\">3.26. roleUpdate<\/a><\/li><li><a href=\"#_roleuser\">3.27. roleUser<\/a><\/li><li><a href=\"#_roleuserresponse\">3.28. roleUserResponse<\/a><\/li><li><a href=\"#_status\">3.29. status<\/a><\/li><li><a href=\"#_updatemicroservice\">3.30. updateMicroservice<\/a><\/li><li><a href=\"#_updatepassword\">3.31. updatePassword<\/a><\/li><li><a href=\"#_updatepermission\">3.32. updatePermission<\/a><\/li><li><a href=\"#_updateuser\">3.33. updateUser<\/a><\/li><li><a href=\"#_userdetails\">3.34. userDetails<\/a><\/li><li><a href=\"#_userlogin\">3.35. userLogin<\/a><\/li><li><a href=\"#_userloginresponse\">3.36. userLoginResponse<\/a><\/li><li><a href=\"#_useroutput\">3.37. userOutput<\/a><\/li><\/ul><\/li><li><a href=\"#_securityscheme\">4. Security<\/a><ul class=\"sectlevel2\"><li><a href=\"#_apiauthkey\">4.1. APIAuthKey<\/a><\/li><\/ul><\/li><\/ul><\/div><\/div><div id=\"content\"><div class=\"sect1\"><h2 id=\"_overview\">1. Overview<\/h2><div class=\"sectionbody\"><div class=\"paragraph\"><p>API design specification documentation of EF AppSuite user management micro service.<\/p><\/div><div class=\"sect2\"><h3 id=\"_version_information\">1.1. Version information<\/h3><div class=\"paragraph\"><p><em>Version<\/em> : 1.0.0<\/p><\/div><\/div><div class=\"sect2\"><h3 id=\"_uri_scheme\">1.2. URI scheme<\/h3><div class=\"paragraph\"><p><em>Host<\/em> : localhost:9091<br><em>BasePath<\/em> : \/umm<br><em>Schemes<\/em> : HTTP<\/p><\/div><\/div><div class=\"sect2\"><h3 id=\"_tags\">1.3. Tags<\/h3><div class=\"ulist\"><ul><li><p>Login : User login operation<\/p><\/li><li><p>User : Operations about users<\/p><\/li><li><p>Microservice : Operations about microservices<\/p><\/li><li><p>Role : Operations about roles<\/p><\/li><li><p>Permission : Operations about permissions<\/p><\/li><\/ul><\/div><\/div><div class=\"sect2\"><h3 id=\"_produces\">1.4. Produces<\/h3><div class=\"ulist\"><ul><li><p><code>application\/json<\/code><\/p><\/li><\/ul><\/div><\/div><\/div><\/div><div class=\"sect1\"><h2 id=\"_paths\">2. Resources<\/h2><div class=\"sectionbody\"><div class=\"sect2\"><h3 id=\"_login_resource\">2.1. Login<\/h3><div class=\"paragraph\"><p>User login operation<\/p><\/div><div class=\"sect3\"><h4 id=\"_api_login_post\">2.1.1. User Login<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>POST \/api\/login<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description\">Description<\/h5><div class=\"paragraph\"><p>This API would be used to login user into the application with specified credentials.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Body<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>user<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Credentails of the user being logged in the application<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_userlogin\">userLogin<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">User LoggedIn Successfully<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_userloginresponse\">userLoginResponse<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Username and\/or password is incorrect<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">HTTP Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/api\/login<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_body\">Request body<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"username\" : \"string\", \"password\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"username\" : \"string\", \"roles\" : [ \"string\" ], \"token_type\" : \"string\", \"access_token\" : \"string\", \"expires_in\" : 0, \"refresh_token\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><\/div><div class=\"sect2\"><h3 id=\"_user_resource\">2.2. User<\/h3><div class=\"paragraph\"><p>Operations about users<\/p><\/div><div class=\"sect3\"><h4 id=\"_user_addrevokemicroserviceroles_put\">2.2.1. Add or revoke user&#8217;s roles<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>PUT \/user\/addRevokeMicroserviceRoles<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_2\">Description<\/h5><div class=\"paragraph\"><p>This API function adds or removes the roles of a user in a particular microservice. A user does not have any roles outside a microservice. A three way binding for user-microservice-role should be maintained.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_2\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Body<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>addRevoke<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">JSON object containing user&#8217;s ID, microservice&#8217;s ID and role&#8217;s ID along with the command (add\/revoke).<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_addrevokeuser\">addRevokeUser<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_2\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">successfull addition or revoking of a user&#8217;s role<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_messageoutputarray\">messageOutputArray<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_2\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_2\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/user\/addRevokeMicroserviceRoles<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_body_2\">Request body<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"id\" : \"string\", \"microservices\" : [ { \"id\" : \"string\", \"roles\" : [ { \"id\" : \"string\" } ] } ], \"addRevoke\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_2\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_2\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : [ \"string\" ]}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_2\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_2\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_2\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_user_create_post\">2.2.2. Create a new User<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>POST \/user\/create<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_3\">Description<\/h5><div class=\"paragraph\"><p>This API would be used to register a new user with the specified attributes namely username, password, email, first name and last name.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_3\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Body<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>user<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">All the attributes of the user being created in JSON format.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_newuser\">newUser<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_3\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">User Created Successfully<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_responsecreateuser\">responseCreateUser<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_2\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_3\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_3\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/user\/create<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_body_3\">Request body<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"username\" : \"string\", \"password\" : \"string\", \"fullName\" : \"string\", \"isActive\" : true, \"email\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_3\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_3\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"user\" : { \"id\" : \"string\", \"username\" : \"string\", \"email\" : \"string\", \"fullName\" : \"string\", \"type\" : \"string\", \"isActive\" : true, \"profileExists\" : true, \"lastLogin\" : 0, \"lastUpdated\" : 0, \"dateCreated\" : 0, \"createdBy\" : \"string\", \"updatedBy\" : \"string\", \"microservices\" : [ { \"id\" : \"string\", \"name\" : \"string\", \"ipAddress\" : \"string\", \"description\" : \"string\", \"roles\" : [ { \"id\" : \"string\", \"name\" : \"string\", \"description\" : \"string\", \"permissions\" : [ { \"id\" : \"string\", \"name\" : \"string\", \"expression\" : \"string\", \"description\" : \"string\" } ] } ] } ] }}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_3\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_2\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406_2\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_3\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_3\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_user_delete_delete\">2.2.3. Delete a User<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>DELETE \/user\/delete<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_4\">Description<\/h5><div class=\"paragraph\"><p>This API would be used to delete application&#8217;s local user.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_4\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Query<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the user being deleted<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (int)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_4\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">User Deleted Successfully<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_messageoutput\">messageOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_3\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_4\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_4\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/user\/delete<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_query\">Request query<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"id\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_4\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_4\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_4\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_3\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_2\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406_3\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_4\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_4\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_user_deletemulti_delete\">2.2.4. Delete multiple users<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>DELETE \/user\/deleteMulti<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_5\">Description<\/h5><div class=\"paragraph\"><p>This is same as delete API but it would be used for bulk user deletion.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_5\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Body<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>deleteMulti<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">JSON object containing an array of user IDs to be deleted.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">&lt; <a href=\"#_idinput\">idInput<\/a> &gt; array<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_5\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">User\/users Deleted Successfully<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_messageoutputarray\">messageOutputArray<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_4\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_5\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_5\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/user\/deleteMulti<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_body_4\">Request body<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">[ { \"id\" : \"string\"} ]<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_5\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_5\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : [ \"string\" ]}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_5\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_4\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_3\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406_4\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_5\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_5\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_user_list_get\">2.2.5. List all the users<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>GET \/user\/list<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_6\">Description<\/h5><div class=\"paragraph\"><p>This API would be used to get list of all users.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_responses_6\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Users List Fetched Successfully<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_useroutput\">userOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_5\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_6\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_6\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/user\/list<\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_6\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_6\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"users\" : [ { \"id\" : \"string\", \"username\" : \"string\", \"email\" : \"string\", \"fullName\" : \"string\", \"type\" : \"string\", \"isActive\" : true, \"profileExists\" : true, \"lastLogin\" : 0, \"lastUpdated\" : 0, \"dateCreated\" : 0, \"createdBy\" : \"string\", \"updatedBy\" : \"string\", \"microservices\" : [ { \"id\" : \"string\", \"name\" : \"string\", \"ipAddress\" : \"string\", \"description\" : \"string\", \"roles\" : [ { \"id\" : \"string\", \"name\" : \"string\", \"description\" : \"string\", \"permissions\" : [ { \"id\" : \"string\", \"name\" : \"string\", \"expression\" : \"string\", \"description\" : \"string\" } ] } ] } ] } ]}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_6\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_5\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_6\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_6\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_user_resetpassword_put\">2.2.6. Reset password<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>PUT \/user\/resetPassword<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_7\">Description<\/h5><div class=\"paragraph\"><p>This API resets the password of a user. Only an admin is privileged to reset password of a user.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_6\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Body<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>resetPassword<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">JSON containing the user ID and the new password.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_resetpassword\">resetPassword<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_7\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Password has been reset successfully.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_messageoutput\">messageOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_6\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_7\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_7\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/user\/resetPassword<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_body_5\">Request body<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"id\" : \"string\", \"newPassword\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_7\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_7\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_7\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_6\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_4\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406_5\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_7\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_7\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_user_show_get\">2.2.7. Get a User&#8217;s detail<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>GET \/user\/show<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_8\">Description<\/h5><div class=\"paragraph\"><p>This API would be used to fetch complete details of any particular user.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_7\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Query<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the user to fetch complete details<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (int)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_8\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Operation Completed Successfully<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_useroutput\">userOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_7\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_8\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_8\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/user\/show<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_query_2\">Request query<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"id\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_8\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_8\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"users\" : [ { \"id\" : \"string\", \"username\" : \"string\", \"email\" : \"string\", \"fullName\" : \"string\", \"type\" : \"string\", \"isActive\" : true, \"profileExists\" : true, \"lastLogin\" : 0, \"lastUpdated\" : 0, \"dateCreated\" : 0, \"createdBy\" : \"string\", \"updatedBy\" : \"string\", \"microservices\" : [ { \"id\" : \"string\", \"name\" : \"string\", \"ipAddress\" : \"string\", \"description\" : \"string\", \"roles\" : [ { \"id\" : \"string\", \"name\" : \"string\", \"description\" : \"string\", \"permissions\" : [ { \"id\" : \"string\", \"name\" : \"string\", \"expression\" : \"string\", \"description\" : \"string\" } ] } ] } ] } ]}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_8\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_7\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_5\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_8\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_8\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_user_update_put\">2.2.8. Update user&#8217;s info<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>PUT \/user\/update<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_9\">Description<\/h5><div class=\"paragraph\"><p>This API function updates the user&#8217;s info viz. email, first name and last name. Username cannot be updated. To update password, call \/user\/updatePassword. If password is forgotten, an admin can invoke \/user\/resetPassword to reset the password.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_8\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Body<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>user<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">JSON containing user&#8217;s ID along with the optional parameters which are to be updated.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_updateuser\">updateUser<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_9\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">user has been updated successfully.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_messageoutput\">messageOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_8\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_9\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_9\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/user\/update<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_body_6\">Request body<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"id\" : \"string\", \"firstName\" : \"string\", \"lastName\" : \"string\", \"email\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_9\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_9\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_9\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_8\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_6\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406_6\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_9\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_9\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_user_updatepassword_put\">2.2.9. Change user&#8217;s password<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>PUT \/user\/updatePassword<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_10\">Description<\/h5><div class=\"paragraph\"><p>This API function changes password of a user. Any user is privileged to change his\/her password<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_9\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Body<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>updatePassword<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id, current password and new password provided as a JSON object.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_updatepassword\">updatePassword<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_10\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Password updated successfully.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_messageoutput\">messageOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_9\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_10\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_10\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/user\/updatePassword<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_body_7\">Request body<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"id\" : \"string\", \"curPassword\" : \"string\", \"newPassword\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_10\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_10\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_10\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_9\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_7\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406_7\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_10\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_10\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><\/div><div class=\"sect2\"><h3 id=\"_microservice_resource\">2.3. Microservice<\/h3><div class=\"paragraph\"><p>Operations about microservices<\/p><\/div><div class=\"sect3\"><h4 id=\"_microservice_addremoveroles_put\">2.3.1. Add or remove roles in a microservice<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>PUT \/microservice\/addRemoveRoles<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_11\">Description<\/h5><div class=\"paragraph\"><p>This API would be used to add or remove any particular roles of a microservice. This is completely irrelevant to the roles of a user in a microservice. That&#8217;s handeled by \/user\/addRevokeMicroserviceRoles operation.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_10\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Body<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>addRemoveRoles<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">JSON contanining microservice id and role ids.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_addremoveroles\">addRemoveRoles<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_11\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Successfully added or removed the roles of a microservice.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_messageoutputarray\">messageOutputArray<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_10\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_11\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_11\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/microservice\/addRemoveRoles<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_body_8\">Request body<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"id\" : \"string\", \"roles\" : [ { \"id\" : \"string\" } ], \"addRemove\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_11\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_11\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : [ \"string\" ]}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_11\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_10\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_8\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406_8\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_11\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_11\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_microservice_create_post\">2.3.2. Create a new microservice<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>POST \/microservice\/create<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_12\">Description<\/h5><div class=\"paragraph\"><p>Registers a new microservice in local DB.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_11\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Body<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>createMicroservice<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">JSON containing name and description of a microservice.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_createmicroservice\">createMicroservice<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_12\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Successfully created the microservice.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_messageoutput\">messageOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_11\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_12\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_12\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/microservice\/create<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_body_9\">Request body<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"name\" : \"string\", \"ipAddress\" : \"string\", \"description\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_12\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_12\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_12\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_11\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_9\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406_9\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_12\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_12\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_microservice_delete_delete\">2.3.3. Delete a microservice<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>DELETE \/microservice\/delete<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_13\">Description<\/h5><div class=\"paragraph\"><p>This API would be used to delete particular microservice.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_12\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Query<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the microservice being deleted<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (int)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_13\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Microservice Deleted Successfully<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_messageoutput\">messageOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_12\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_13\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_13\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/microservice\/delete<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_query_3\">Request query<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"id\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_13\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_13\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_13\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_12\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_10\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406_10\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_13\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_13\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_microservice_list_get\">2.3.4. List all microservices<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>GET \/microservice\/list<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_14\">Description<\/h5><div class=\"paragraph\"><p>This API would be used to fetch complete details of all microServices i.e, roles and corresponding permissions.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_responses_14\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Operation Completed Successfully<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_microserviceoutput\">microserviceOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_13\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_14\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_14\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/microservice\/list<\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_14\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_14\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"microservices\" : [ { \"id\" : \"string\", \"name\" : \"string\", \"ipAddress\" : \"string\", \"description\" : \"string\", \"roles\" : [ { \"id\" : \"string\", \"name\" : \"string\", \"description\" : \"string\", \"permissions\" : [ { \"id\" : \"string\", \"name\" : \"string\", \"expression\" : \"string\", \"description\" : \"string\" } ] } ] } ]}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_14\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_13\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_14\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_14\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_microservice_show_get\">2.3.5. Get a microservice<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>GET \/microservice\/show<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_15\">Description<\/h5><div class=\"paragraph\"><p>This API would be used to fetch complete details of any particular microService i.e, roles and corresponding permissions.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_13\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Query<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the microservice to fetch complete details<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (int)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_15\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Operation Completed Successfully<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_microserviceshowoutput\">microserviceShowOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_14\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_15\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_15\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/microservice\/show<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_query_4\">Request query<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"id\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_15\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_15\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"microservice\" : { \"id\" : \"string\", \"name\" : \"string\", \"ipAddress\" : \"string\", \"description\" : \"string\", \"roles\" : [ { \"id\" : \"string\", \"name\" : \"string\", \"description\" : \"string\", \"permissions\" : [ { \"id\" : \"string\", \"name\" : \"string\", \"expression\" : \"string\", \"description\" : \"string\" } ] } ] }}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_15\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_14\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_11\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_15\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_15\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_microservice_update_put\">2.3.6. Update a microservice<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>PUT \/microservice\/update<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_16\">Description<\/h5><div class=\"paragraph\"><p>Updates the attributes of a microservice viz. name, ip Address and\/or the description.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_14\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Body<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>updateMicroService<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">microService to be updated.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_updatemicroservice\">updateMicroservice<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_16\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Successfully updated the microservice.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_messageoutput\">messageOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_15\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_16\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_16\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/microservice\/update<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_body_10\">Request body<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"id\" : \"string\", \"name\" : \"string\", \"ipAddress\" : \"string\", \"description\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_16\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_16\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_16\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_15\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_12\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406_11\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_16\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_16\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><\/div><div class=\"sect2\"><h3 id=\"_role_resource\">2.4. Role<\/h3><div class=\"paragraph\"><p>Operations about roles<\/p><\/div><div class=\"sect3\"><h4 id=\"_role_addrevokepermissions_put\">2.4.1. Add or revoke permissions from a role<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>PUT \/role\/addRevokePermissions<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_17\">Description<\/h5><div class=\"paragraph\"><p>This API function adds or revokes the permissions grouped in a role.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_15\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Body<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>role<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Object containing role&#8217;s ID along with the IDs of permissions to be added or revoked.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_addrevokepermissions\">addRevokePermissions<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_17\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Successfully added\/revoked the permissions of a role.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_messageoutputarray\">messageOutputArray<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_16\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_17\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_17\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/role\/addRevokePermissions<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_body_11\">Request body<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"id\" : \"string\", \"addRevoke\" : \"string\", \"permissions\" : [ { \"id\" : \"string\" } ]}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_17\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_17\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : [ \"string\" ]}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_17\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_16\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_13\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406_12\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_17\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_17\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_role_create_post\">2.4.2. Create a new role<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>POST \/role\/create<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_18\">Description<\/h5><div class=\"paragraph\"><p>This API function creates a new role.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_16\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Body<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>role<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">An object containing attributes of a role.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_createrole\">createRole<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_18\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Successfully created a role.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_messageoutput\">messageOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_17\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_18\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_18\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/role\/create<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_body_12\">Request body<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"authority\" : \"string\", \"description\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_18\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_18\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_18\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_17\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_14\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406_13\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_18\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_18\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_role_delete_delete\">2.4.3. Delete a role<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>DELETE \/role\/delete<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_19\">Description<\/h5><div class=\"paragraph\"><p>Delete the specified role. Request can only succeed if role has no user.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_17\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Query<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the role being deleted<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (int)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_19\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Successfully deleted a role for microservice.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_messageoutput\">messageOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_18\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_19\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_19\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/role\/delete<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_query_5\">Request query<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"id\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_19\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_19\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_19\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_18\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_15\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_19\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_19\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_role_deletemulti_delete\">2.4.4. Delete multiple roles<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>DELETE \/role\/deleteMulti<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_20\">Description<\/h5><div class=\"paragraph\"><p>This is same as delete API but it would be used for bulk role deletion.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_18\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Body<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>deleteMulti<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">JSON object containing an array of role IDs to be deleted.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">&lt; <a href=\"#_idinput\">idInput<\/a> &gt; array<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_20\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">role\/roles Deleted Successfully<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_messageoutputarray\">messageOutputArray<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_19\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_20\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_20\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/role\/deleteMulti<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_body_13\">Request body<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">[ { \"id\" : \"string\"} ]<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_20\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_20\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : [ \"string\" ]}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_20\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_19\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_16\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406_14\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_20\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_20\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_role_list_get\">2.4.5. List all the roles.<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>GET \/role\/list<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_21\">Description<\/h5><div class=\"paragraph\"><p>Lists the roles with their permissions.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_responses_21\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Successfully fetched the list of all roles.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_roleoutput\">roleOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_20\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_21\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_21\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/role\/list<\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_21\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_21\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"roles\" : [ { \"id\" : \"string\", \"name\" : \"string\", \"description\" : \"string\", \"permissions\" : [ { \"id\" : \"string\", \"name\" : \"string\", \"expression\" : \"string\", \"description\" : \"string\" } ] } ]}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_21\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_20\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406_15\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_21\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_21\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_role_roleuser_get\">2.4.6. Get the list of users for a particular role.<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>GET \/role\/roleUser<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_22\">Description<\/h5><div class=\"paragraph\"><p>This API function adds or revokes the permissions grouped in a roll.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_19\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Query<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the role to fetch complete details<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (int)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_22\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Successfully fetched the list of users having a particular role.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_roleuserresponse\">roleUserResponse<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_21\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_22\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_22\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/role\/roleUser<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_query_6\">Request query<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"id\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_22\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_22\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"users\" : [ { \"id\" : \"string\", \"username\" : \"string\", \"email\" : \"string\", \"fullName\" : \"string\", \"type\" : \"string\", \"isActive\" : true, \"profileExists\" : true, \"lastLogin\" : 0, \"lastUpdated\" : 0, \"dateCreated\" : 0, \"createdBy\" : \"string\", \"updatedBy\" : \"string\" } ]}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_22\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_21\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_17\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406_16\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_22\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_22\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_role_show_get\">2.4.7. Show a particular role<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>GET \/role\/show<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_23\">Description<\/h5><div class=\"paragraph\"><p>Show details of a particular role with corresponding permissions.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_20\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Query<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the role to fetch complete details<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (int)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_23\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Successfully fetched the particulars of a role.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_roleshowoutput\">roleShowOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_22\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_23\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_23\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/role\/show<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_query_7\">Request query<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"id\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_23\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_23\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"role\" : { \"id\" : \"string\", \"name\" : \"string\", \"description\" : \"string\", \"permissions\" : [ { \"id\" : \"string\", \"name\" : \"string\", \"expression\" : \"string\", \"description\" : \"string\" } ] }}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_23\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_22\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_18\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406_17\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_23\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_23\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_role_update_put\">2.4.8. Update an existing role.<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>PUT \/role\/update<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_24\">Description<\/h5><div class=\"paragraph\"><p>This API updates the attributes of a role viz. authority and description.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_21\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Body<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>updateRole<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Object containing attributes of a role.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_roleupdate\">roleUpdate<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_24\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Successfully updated the role.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_messageoutput\">messageOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_23\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_24\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_24\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/role\/update<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_body_14\">Request body<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"id\" : \"string\", \"authority\" : \"string\", \"description\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_24\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_24\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_24\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_23\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_19\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406_18\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_24\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_24\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><\/div><div class=\"sect2\"><h3 id=\"_permission_resource\">2.5. Permission<\/h3><div class=\"paragraph\"><p>Operations about permissions<\/p><\/div><div class=\"sect3\"><h4 id=\"_permission_create_post\">2.5.1. Create a new permission<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>POST \/permission\/create<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_25\">Description<\/h5><div class=\"paragraph\"><p>This API function creates a new permission.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_22\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Body<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>permission<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">JSON object containing name, expression and description of the new permission to be created.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_createpermission\">createPermission<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_25\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Successfully created new permission.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_messageoutput\">messageOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_24\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_25\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_25\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/permission\/create<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_body_15\">Request body<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"name\" : \"string\", \"expression\" : \"string\", \"description\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_25\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_25\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_25\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_24\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_20\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406_19\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_25\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_25\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_permission_delete_delete\">2.5.2. Delete a permission<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>DELETE \/permission\/delete<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_26\">Description<\/h5><div class=\"paragraph\"><p>Delete a permission specified by the ID.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_23\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Query<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the permission being deleted<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (int)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_26\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Successfully deleted a permission.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_messageoutput\">messageOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_25\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_26\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_26\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/permission\/delete<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_query_8\">Request query<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"id\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_26\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_26\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_26\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_25\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_21\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_26\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_26\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_permission_list_get\">2.5.3. List all the permissions.<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>GET \/permission\/list<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_27\">Description<\/h5><div class=\"paragraph\"><p>Lists the all the permissions in the system.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_responses_27\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Successfully fetched the list of all permissions.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_permoutput\">permOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_26\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_27\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_27\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/permission\/list<\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_27\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_27\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"permissions\" : [ { \"id\" : \"string\", \"name\" : \"string\", \"expression\" : \"string\", \"description\" : \"string\" } ]}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_27\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_26\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_27\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_27\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_permission_show_get\">2.5.4. Show a permission.<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>GET \/permission\/show<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_28\">Description<\/h5><div class=\"paragraph\"><p>Show particulars of permission in the system.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_24\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Query<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the permission to fetch complete details<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (int)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_28\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Successfully fetched the particular permission&#8217;s details.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_permshowoutput\">permShowOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_27\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_28\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_28\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/permission\/show<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_query_9\">Request query<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"id\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_28\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_28\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"permission\" : { \"id\" : \"string\", \"name\" : \"string\", \"expression\" : \"string\", \"description\" : \"string\" }}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_28\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_27\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_22\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_28\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_28\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><div class=\"sect3\"><h4 id=\"_permission_update_put\">2.5.5. Update an existing permission<\/h4><div class=\"literalblock\"><div class=\"content\"><pre>PUT \/permission\/update<\/pre><\/div><\/div><div class=\"sect4\"><h5 id=\"_description_29\">Description<\/h5><div class=\"paragraph\"><p>This API function updates an existing permission.<\/p><\/div><\/div><div class=\"sect4\"><h5 id=\"_parameters_25\">Parameters<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 11.1111%;\"><col style=\"width: 16.6666%;\"><col style=\"width: 50%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Body<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>updatePermission<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">contains id, name, expression and description of the permission to be updated.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_updatepermission\">updatePermission<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_responses_29\">Responses<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 10%;\"><col style=\"width: 70%;\"><col style=\"width: 20%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">HTTP Code<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>200<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Successfully updated the permission.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_messageoutput\">messageOutput<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>401<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unauthorized. Token authentication failed.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_401out\">401Out<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>403<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Access denied. User is forbidden to access this resource.<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>404<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not found<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>405<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Method Not Allowed<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">No Content<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>406<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Not acceptable<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>500<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Internal Server Error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_errorformat\">errorFormat<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>default<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Unexpected error<\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_error\">Error<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_security_28\">Security<\/h5><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 42.8571%;\"><col style=\"width: 57.1429%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Type<\/th><th class=\"tableblock halign-left valign-middle\">Name<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>apiKey<\/strong><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong><a href=\"#_apiauthkey\">APIAuthKey<\/a><\/strong><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect4\"><h5 id=\"_example_http_request_29\">Example HTTP request<\/h5><div class=\"sect5\"><h6 id=\"_request_path_29\">Request path<\/h6><div class=\"listingblock\"><div class=\"content\"><pre>\/permission\/update<\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_request_body_16\">Request body<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"id\" : \"string\", \"name\" : \"string\", \"expression\" : \"string\", \"description\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><div class=\"sect4\"><h5 id=\"_example_http_response_29\">Example HTTP response<\/h5><div class=\"sect5\"><h6 id=\"_response_200_29\">Response 200<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_401_29\">Response 401<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"timestamp\" : 0, \"status\" : 0, \"error\" : \"string\", \"message\" : \"string\", \"path\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_403_28\">Response 403<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_404_23\">Response 404<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_406_20\">Response 406<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_500_29\">Response 500<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"status\" : { \"enumType\" : \"string\", \"name\" : \"string\" }, \"message\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><div class=\"sect5\"><h6 id=\"_response_default_29\">Response default<\/h6><div class=\"listingblock\"><div class=\"content\"><pre class=\"highlight\"><code class=\"language-json\" data-lang=\"json\">{ \"code\" : 0, \"message\" : \"string\", \"fields\" : \"string\"}<\/code><\/pre><\/div><\/div><\/div><\/div><\/div><\/div><\/div><\/div><div class=\"sect1\"><h2 id=\"_definitions\">3. Definitions<\/h2><div class=\"sectionbody\"><div class=\"sect2\"><h3 id=\"_401out\">3.1. 401Out<\/h3><div class=\"paragraph\"><p>Output response for 401 response.<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>error<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>message<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>path<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>status<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>0<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">integer<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>timestamp<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>0<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">integer<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_error\">3.2. Error<\/h3><div class=\"paragraph\"><p>Output response for undocumented default error.<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>code<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>0<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">integer (int32)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>fields<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>message<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_addremoveroles\">3.3. addRemoveRoles<\/h3><div class=\"paragraph\"><p>Input parameter for \/microservice\/addRemoveRoles.<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>addRemove<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">\'add\' or \'remove\' command for respective operation.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">enum (add, remove)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">ID of the microservice for which role is being added or removed.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>roles<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">List of roles being added or removed from the microservice.<br><strong>Example<\/strong> : <code>[ \"<a href=\"#_idinput\">idInput<\/a>\" ]<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">&lt; <a href=\"#_idinput\">idInput<\/a> &gt; array<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_addrevokepermissions\">3.4. addRevokePermissions<\/h3><div class=\"paragraph\"><p>Input parameter of \/role\/addRevokePermission<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>addRevoke<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">\'add\' or \'revoke\' command for corresponding action.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">enum (add, revoke)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the role for which permissions are being added or revoked.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>permissions<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">List of permission Ids to be added or revoked from a role.<br><strong>Example<\/strong> : <code>[ \"<a href=\"#_idinput\">idInput<\/a>\" ]<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">&lt; <a href=\"#_idinput\">idInput<\/a> &gt; array<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_addrevokeuser\">3.5. addRevokeUser<\/h3><div class=\"paragraph\"><p>Input parameter for \/user\/addRevokeMicroservice\/Roles<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>addRevoke<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">\'add\' or \'revoke\' command for respective operation.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">enum (add, revoke)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the user for which roles roles are being added or revoked.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>microservices<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">List of microservice ids with embedded role ID list.<br><strong>Example<\/strong> : <code>[ \"<a href=\"#_multiroles\">multiRoles<\/a>\" ]<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">&lt; <a href=\"#_multiroles\">multiRoles<\/a> &gt; array<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_createmicroservice\">3.6. createMicroservice<\/h3><div class=\"paragraph\"><p>Input parameter for \/microservice\/create.<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>description<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Short description about the microservice being created.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>ipAddress<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">IP address of the deployed microservice with http\/https prefix.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>name<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Name of the microservice to be created.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_createpermission\">3.7. createPermission<\/h3><div class=\"paragraph\"><p>Input parameter of \/permission\/create<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>description<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Short description about the permission.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>expression<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">All the access control is based on expression of permission. Access is authorized if a user has corresponding expression . Format of the expresion should be \'controller:*\' or \'controller:action\'.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>name<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Name of the permission. It should be formatted as \'com.ef.[microservice_name].[controller_name].[action_name]\'. Square brackets are just place holders. For example com.ef.umm.user.list would be an appropriate permission name. \'*\' can be used as a wildcard for action_name in permission&#8217;s name as well as expression.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_createrole\">3.8. createRole<\/h3><div class=\"paragraph\"><p>Input parameter of \/role\/create<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>authority<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Name of the role. It should ideally be prefixed with \'ROLE_\' and should be in capital letters. This is not a hard requirement though.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>description<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Short description about the role.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_errorformat\">3.9. errorFormat<\/h3><div class=\"paragraph\"><p>Output response format for documented errors.<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>message<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>status<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"<a href=\"#_status\">status<\/a>\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_status\">status<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_idinput\">3.10. idInput<\/h3><div class=\"paragraph\"><p>This is a multipurpose model used for input parameters where only id is required.<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">ID of the entity.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_messageoutput\">3.11. messageOutput<\/h3><div class=\"paragraph\"><p>General purpose single message output model.<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>message<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Info or error message to be displayed.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>status<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"<a href=\"#_status\">status<\/a>\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_status\">status<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_messageoutputarray\">3.12. messageOutputArray<\/h3><div class=\"paragraph\"><p>General purpose multi message output model.<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>message<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Array of messages to be displayed.<br><strong>Example<\/strong> : <code>[ \"string\" ]<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">&lt; string &gt; array<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>status<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"<a href=\"#_status\">status<\/a>\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_status\">status<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_microservice\">3.13. microService<\/h3><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>description<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Short description about the mciroservice.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">id of the microservice<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>ipAddress<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">IP address of the deployed microservice with http\/https prefix.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>name<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">name of the microservice<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>roles<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">List of roles in a microservice.<br><strong>Example<\/strong> : <code>[ \"<a href=\"#_role\">role<\/a>\" ]<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">&lt; <a href=\"#_role\">role<\/a> &gt; array<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_microserviceoutput\">3.14. microserviceOutput<\/h3><div class=\"paragraph\"><p>Output for 200 response of \/microservice\/list.<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>microservices<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>[ \"<a href=\"#_microservice\">microService<\/a>\" ]<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">&lt; <a href=\"#_microservice\">microService<\/a> &gt; array<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>status<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"<a href=\"#_status\">status<\/a>\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_status\">status<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_microserviceshowoutput\">3.15. microserviceShowOutput<\/h3><div class=\"paragraph\"><p>Output for 200 response of \/microservice\/show.<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>microservice<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"<a href=\"#_microservice\">microService<\/a>\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_microservice\">microService<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>status<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"<a href=\"#_status\">status<\/a>\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_status\">status<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_multiroles\">3.16. multiRoles<\/h3><div class=\"paragraph\"><p>To be used as sub model for addRevokeUser model.<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the microservice for which role is being added or revoked.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>roles<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">List of role Ids being added or revoked from user.<br><strong>Example<\/strong> : <code>[ \"<a href=\"#_idinput\">idInput<\/a>\" ]<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">&lt; <a href=\"#_idinput\">idInput<\/a> &gt; array<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_newuser\">3.17. newUser<\/h3><div class=\"paragraph\"><p>Input parameter of \/user\/create<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>email<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>fullName<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>isActive<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>true<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">boolean (boolean)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>password<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (password)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>username<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_permoutput\">3.18. permOutput<\/h3><div class=\"paragraph\"><p>Output response of \/permission\/list for 200<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>permissions<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>[ \"<a href=\"#_permission\">permission<\/a>\" ]<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">&lt; <a href=\"#_permission\">permission<\/a> &gt; array<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>status<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"<a href=\"#_status\">status<\/a>\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_status\">status<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_permshowoutput\">3.19. permShowOutput<\/h3><div class=\"paragraph\"><p>Output response of \/permission\/show for 200<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>permission<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"<a href=\"#_permission\">permission<\/a>\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_permission\">permission<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>status<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"<a href=\"#_status\">status<\/a>\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_status\">status<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_permission\">3.20. permission<\/h3><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>description<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Short description about the permission.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>expression<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">All the access control is based on expression of permission. Access is authorized if a user has corresponding expression . Format of the expresion should be \'controller:*\' or \'controller:action\'.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">id of the permission.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>name<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Name of the permission. It should be formatted as \'com.ef.[microservice_name].[controller_name].[action_name]\'. Square brackets are just place holders. For example com.ef.umm.user.list would be an appropriate permission name. \'*\' can be used as a wildcard for action_name in permission&#8217;s name as well as expression.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_resetpassword\">3.21. resetPassword<\/h3><div class=\"paragraph\"><p>Input parameter for \/user\/resetPassword.<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the user whose password is being reset.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>newPassword<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">New password of the user.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (password)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_responsecreateuser\">3.22. responseCreateUser<\/h3><div class=\"paragraph\"><p>Data structure for the output reponse of the create API for user.<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>status<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"<a href=\"#_status\">status<\/a>\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_status\">status<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>user<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"<a href=\"#_userdetails\">userDetails<\/a>\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_userdetails\">userDetails<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_role\">3.23. role<\/h3><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>description<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Short description about the role.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">id of the role<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>name<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">name of the role<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>permissions<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">List of permissions in a role.<br><strong>Example<\/strong> : <code>[ \"<a href=\"#_permission\">permission<\/a>\" ]<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">&lt; <a href=\"#_permission\">permission<\/a> &gt; array<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_roleoutput\">3.24. roleOutput<\/h3><div class=\"paragraph\"><p>Output response of \/role\/list for 200<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>roles<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>[ \"<a href=\"#_role\">role<\/a>\" ]<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">&lt; <a href=\"#_role\">role<\/a> &gt; array<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>status<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"<a href=\"#_status\">status<\/a>\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_status\">status<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_roleshowoutput\">3.25. roleShowOutput<\/h3><div class=\"paragraph\"><p>Output response of \/role\/show for 200<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>role<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"<a href=\"#_role\">role<\/a>\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_role\">role<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>status<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"<a href=\"#_status\">status<\/a>\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_status\">status<\/a><\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_roleupdate\">3.26. roleUpdate<\/h3><div class=\"paragraph\"><p>Input parameter of \/role\/update<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>authority<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Name of the role. It should ideally be prefixed with \'ROLE_\' and should be in capital letters. This is not a hard requirement though.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>description<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Description of the role being updated.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the role being updated.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_roleuser\">3.27. roleUser<\/h3><div class=\"paragraph\"><p>Data structure for the output of user details without any microservice\/role\/permission information.<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>createdBy<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">ID of the user who created this user.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>dateCreated<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Date of user creation.<br><strong>Example<\/strong> : <code>0<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">integer<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>email<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">User&#8217;s email.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>fullName<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Full name of the user.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the user<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (int)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>isActive<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Whether a user is active or not.<br><strong>Example<\/strong> : <code>true<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">boolean<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>lastLogin<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Date of last login.<br><strong>Example<\/strong> : <code>0<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">integer<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>lastUpdated<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Date of the last update.<br><strong>Example<\/strong> : <code>0<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">integer<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>profileExists<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Whether profile picture of a user is present or not.<br><strong>Example<\/strong> : <code>true<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">boolean<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>type<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Type of the user. It can either be CC(contact center), DB (local Database) or AD (the active directory).<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>updatedBy<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">ID of the user who updated this user.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>username<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">username of the user<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_roleuserresponse\">3.28. roleUserResponse<\/h3><div class=\"paragraph\"><p>Data structure for responding to roleUser API.<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>status<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"<a href=\"#_status\">status<\/a>\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_status\">status<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>users<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>[ \"<a href=\"#_roleuser\">roleUser<\/a>\" ]<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">&lt; <a href=\"#_roleuser\">roleUser<\/a> &gt; array<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_status\">3.29. status<\/h3><div class=\"paragraph\"><p>Generic status model to be embedded in most of the output responses.<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>enumType<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>name<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_updatemicroservice\">3.30. updateMicroservice<\/h3><div class=\"paragraph\"><p>Input parameter for \/microservice\/update.<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>description<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">New description of the microservice if it needs to be updated.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the microservice being updated.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>ipAddress<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">IP address of the deployed microservice with http\/https prefix. Provide old address if it isn&#8217;t being updated, new otherwise.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>name<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">New name of the microservice if it is being updated. Provide old name anyway if you are not updating name field.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_updatepassword\">3.31. updatePassword<\/h3><div class=\"paragraph\"><p>Input parameter for \/user\/updatePassword<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>curPassword<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Current password of the user.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (password)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the user whose password is being updated.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>newPassword<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">New password of the user.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (password)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_updatepermission\">3.32. updatePermission<\/h3><div class=\"paragraph\"><p>Input parameter of \/permission\/update<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>description<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Short description about the permission.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>expression<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">All the access control is based on expression of permission. Access is authorized if a user has corresponding expression . Format of the expresion should be \'controller:*\' or \'controller:action\'.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the permission being updated.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>name<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Name of the permission. It should be formatted as \'com.ef.[microservice_name].[controller_name].[action_name]\'. Square brackets are just place holders. For example com.ef.umm.user.list would be an appropriate permission name. \'*\' can be used as a wildcard for action_name in permission&#8217;s name as well as expression.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_updateuser\">3.33. updateUser<\/h3><div class=\"paragraph\"><p>Input parameter for \/user\/update<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>email<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">email of the user being updated.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>firstName<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">User&#8217;s first name.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the user being updated.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>lastName<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">User&#8217;s last name.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_userdetails\">3.34. userDetails<\/h3><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>createdBy<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">ID of the user who created this user.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>dateCreated<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Date of user creation.<br><strong>Example<\/strong> : <code>0<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">integer<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>email<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">User&#8217;s email.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>fullName<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Full name of the user.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>id<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Id of the user<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (int)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>isActive<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Whether a user is active or not.<br><strong>Example<\/strong> : <code>true<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">boolean<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>lastLogin<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Date of last login.<br><strong>Example<\/strong> : <code>0<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">integer<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>lastUpdated<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Date of the last update.<br><strong>Example<\/strong> : <code>0<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">integer<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>microservices<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">List of microservices with corresponding roles and permissions for a particular user.<br><strong>Example<\/strong> : <code>[ \"<a href=\"#_microservice\">microService<\/a>\" ]<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">&lt; <a href=\"#_microservice\">microService<\/a> &gt; array<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>profileExists<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Whether profile picture of a user is present or not.<br><strong>Example<\/strong> : <code>true<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">boolean<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>type<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">Type of the user. It can either be CC(contact center), DB (local Database) or AD (the active directory).<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>updatedBy<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">ID of the user who updated this user.<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>username<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">username of the user<br><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_userlogin\">3.35. userLogin<\/h3><div class=\"paragraph\"><p>Input parameter of \/api\/login<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>password<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (password)<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>username<\/strong><br><em>required<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string (string)<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_userloginresponse\">3.36. userLoginResponse<\/h3><div class=\"paragraph\"><p>Output response of \/api\/login for 200.<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>access_token<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>expires_in<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>0<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">integer<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>refresh_token<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>roles<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>[ \"string\" ]<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">&lt; string &gt; array<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>token_type<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>username<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"string\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">string<\/p><\/td><\/tr><\/tbody><\/table><\/div><div class=\"sect2\"><h3 id=\"_useroutput\">3.37. userOutput<\/h3><div class=\"paragraph\"><p>Output response of \/user\/list for 200.<\/p><\/div><table class=\"tableblock frame-all grid-all spread\"><colgroup><col style=\"width: 16.6666%;\"><col style=\"width: 61.1111%;\"><col style=\"width: 22.2223%;\"><\/colgroup><thead><tr><th class=\"tableblock halign-left valign-middle\">Name<\/th><th class=\"tableblock halign-left valign-middle\">Description<\/th><th class=\"tableblock halign-left valign-middle\">Schema<\/th><\/tr><\/thead><tbody><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>status<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>\"<a href=\"#_status\">status<\/a>\"<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><a href=\"#_status\">status<\/a><\/p><\/td><\/tr><tr><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>users<\/strong><br><em>optional<\/em><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\"><strong>Example<\/strong> : <code>[ \"<a href=\"#_userdetails\">userDetails<\/a>\" ]<\/code><\/p><\/td><td class=\"tableblock halign-left valign-middle\"><p class=\"tableblock\">&lt; <a href=\"#_userdetails\">userDetails<\/a> &gt; array<\/p><\/td><\/tr><\/tbody><\/table><\/div><\/div><\/div><div class=\"sect1\"><h2 id=\"_securityscheme\">4. Security<\/h2><div class=\"sectionbody\"><div class=\"sect2\"><h3 id=\"_apiauthkey\">4.1. APIAuthKey<\/h3><div class=\"paragraph\"><p><em>Type<\/em> : apiKey<br><em>Name<\/em> : Authorization<br><em>In<\/em> : HEADER<\/p><\/div><\/div><\/div><\/div><\/div><div id=\"footer\"><div id=\"footer-text\">Last updated 2018-03-15 00:23:54 PKT<\/div><\/div>"
}