{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c1e569fd-9408-4ec0-af71-814359589c5d","name":"Accounts APIs - Official","description":"Documentation for Accounts APIs. This collection contains the endpoints available in accounts api. The documentaion details the request and reponse formats. Each request needs to be o-auth authenticated.\n\nAccapi sets cookies after a user has successfuly logged in through either of the auth providers. Each request subsecuently uses that cookie to authorize itself. To test the endpoints you need to login into accapi and then make sure that each request has access to the cookie.\n\nThe collection is divided into three folders:\n\n*   `Apps`: It contains all the apis related to 'apps'.\n*   `User`: It contains all the endpoints related to 'user' management.\n*   `Clusters`: It contains all the endpoints related to 'EAAS', i.e 'Elasticsearch As A Service'.\n    \n\n# Authentication\n\nCurrently, two modes of authentication are supported by Appbase: oauth and basic auth. For oauth there are three supported providers:\n\n*   `Google`\n*   `Github`\n*   `GitLab`\n    \n\nThe requests need to be authenticated by providing the token for oauth. In order to fetch the token for OAuth:\n\n``` curl\ncurl -X POST -d \"client_id=&client_secret=&grant_type=password&username=&password=\" \n\n```\n\nAlong with oauth, the users also have an option to login to appbase.io via email-otp based authentication. It is a two step authentication where the user provides the email address via `/user/email` endpoint which triggers an OTP being sent to the provided email. Subsequently, the user must verify the OTP via `/user/verify` endpoint. See `/user/email` and `/user/verify` endpoints for more details.\n\n  \n  \nBasic auth serves as an option for all endpoints along with oauth authentication. To authorize using basic auth, use the \\`-u\\` flag with each request:  \n  \n  \n  \n\n``` curl\ncurl \"\" -u $credentials\n\n```\n\n  \n  \nAlternatively you can set the \\`Authorization\\` header flag directly with \"Basic + base_64($credentials)\".  \n  \n\n``` curl\nbase64_credentials=YjdqV2hVSjhYOjcyYmI2ZmMxLWRkZjItNDU5Zi1iNGM3LWU2NzgwNjQyM2MyZA==\ncurl \"\" -h \"Authorization: Basic $base64_credentials\"\n\n```\n\nAll appbase.io require `$(credentials)`. appbase.io service offers two types of credentials:\n\n1.  **Read Only**: These are good for public environments.\n2.  **Read and Write**: These are good for secure environments, servers and API users.\n    \n\n[Get your own credentials from your appbase.io app's dashboard](https://dashboard.appbase.io)","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"2774860","team":70041,"collectionId":"c1e569fd-9408-4ec0-af71-814359589c5d","publishedId":"S1ZxcVuL","public":true,"publicUrl":"https://accapi-docs.appbase.io","privateUrl":"https://go.postman.co/documentation/2774860-c1e569fd-9408-4ec0-af71-814359589c5d","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2019-08-12T16:21:06.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"ACCAPI Example.template","id":"08d1c493-6e37-493b-9e47-22f776bf3c0f","owner":"2848488","values":[{"key":"APP_ID","value":"36","enabled":true},{"key":"APP","value":"testmappings","enabled":true},{"key":"APP_CREDENTIALS","value":"3CTOmp0cp:FDD9AE1E-4C57-48C1-851C-3D5D7B027E44","enabled":true},{"key":"CLUSTER_ID","value":"UIrXntz","enabled":true},{"key":"DEPLOYMENT_NAME","value":"elasticsearch","enabled":true},{"key":"USER_EMAIL","value":"pnc.raj@gmail.com","enabled":true},{"key":"HOST","value":"https://accapi.appbase.io","enabled":true},{"key":"REACTIVEAPPNAME","value":"react201","enabled":true},{"key":"APP_PASSWORD_","value":"FDD9AE1E-4C57-48C1-851C-3D5D7B027E44","enabled":false},{"key":"host","value":"https://accapi.appbase.io","enabled":true},{"key":"TEMPLATE","value":"my_template","enabled":true},{"key":"RULE_ID","value":"contains_macbook","enabled":true},{"key":"USERNAME","value":"3CTOmp0cp","enabled":true},{"key":"ROLE","value":"admin","enabled":true},{"key":"ARC_ID","value":"8cc0e2cb-1a36-4249-92a6-782282dbd25b","enabled":true}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":"https://appbase.io/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"ACCAPI Example.template","value":"2848488-08d1c493-6e37-493b-9e47-22f776bf3c0f"}],"canonicalUrl":"https://accapi-docs.appbase.io/view/metadata/S1ZxcVuL"}