{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/account/auth/","auth":"never","examples":{"codes":[{"language":"curl","code":"curl -X POST \\\n-H \"Content-Type: application/json\" \\\n-d '{\"email\":\"<EMAIL_ADDRESS>\",\n     \"password\":\"<PASSWORD>\"}' \\\n\"https://api.syncano.io/v1.1/account/auth/\"","name":""},{"code":"import syncano\n\n# admin login\nconnection = syncano.connect(email=\"EMAIL\", password=\"PASSWORD\")\n\n# user login\nconnection = syncano.connect(\n    username=\"USERNAME\", \n    password=\"PASSWORD\", \n    api_key=\"API_KEY\", \n\t  instance_name=\"INSTANCE_NAME\"\n)\n","language":"python"},{"language":"javascript","code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar Account = connection.Account;\n\nvar credentials = {email: \"EMAIL\", password: \"PASSWORD\"};\n\nAccount.login(credentials).then(callback);"}]},"method":"post","params":[{"name":"email","type":"string","default":"","desc":"Admin email","required":true,"in":"body","ref":"","_id":"54f87324b3c06a0d00eff1ca"},{"name":"password","type":"string","default":"","desc":"Admin password","required":true,"in":"body","ref":"","_id":"54f87324b3c06a0d00eff1c9"}],"results":{"codes":[{"code":"{\n  \"first_name\": \"Geralt\",\n  \"last_name\": \"\",\n  \"is_active\": true,\n  \"account_key\": \"90hj75g7ff74e24341c86x80g39fba5d94b3c991\",\n  \"email\": \"geralt:::at:::from.rivia\",\n  \"has_password\": true,\n  \"id\": 823355\n}","language":"json","status":200,"name":""},{"name":"","code":"{\n  \"password\": [\n    \"This field is required.\"\n  ]\n}","language":"json","status":400},{"status":401,"language":"json","code":"{\n  \"detail\": \"Invalid email or password.\"\n}"},{"code":"","status":403,"language":"json"},{"code":"","language":"json","status":404}]},"settings":"56c50c06d1b8770d00922288"},"next":{"description":"","pages":[]},"title":"Account - log in","type":"endpoint","slug":"account-log-in","excerpt":"Use to log in into your account and receive your Account Key. Doesn't require passing API or Account Key.","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Returns\"\n}\n[/block]\n Information about Admin (account) and your `Account Key`.","updates":[],"order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c50634bdcde80d004986cb","user":"54774c47f3736008009e9e0c","category":{"sync":{"isSync":false,"url":""},"pages":["56c50634bdcde80d004986cb","56c50634bdcde80d004986cc","56c50634bdcde80d004986cd","56c50634bdcde80d004986ce","56c50634bdcde80d004986cf","56c50634bdcde80d004986d0","56c50634bdcde80d004986d1","56c50634bdcde80d004986d2","56c50634bdcde80d004986d3","56c50634bdcde80d004986d4","56c50634bdcde80d004986d5","56c50634bdcde80d004986d6","56c50634bdcde80d004986d7"],"title":"Account","slug":"account","order":20,"from_sync":false,"reference":true,"_id":"56c50628bdcde80d00498647","version":"56c50626bdcde80d00498635","__v":1,"createdAt":"2015-03-17T14:10:23.450Z","project":"54774d9af3736008009e9e0e"},"githubsync":"","project":"54774d9af3736008009e9e0e","version":{"version":"0.1.1","version_clean":"0.1.1","codename":"API v1.1","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":true,"categories":["56c50628bdcde80d00498636","56c50628bdcde80d00498637","56c50628bdcde80d00498638","56c50628bdcde80d00498639","56c50628bdcde80d0049863a","56c50628bdcde80d0049863b","56c50628bdcde80d0049863c","56c50628bdcde80d0049863d","56c50628bdcde80d0049863e","56c50628bdcde80d0049863f","56c50628bdcde80d00498640","56c50628bdcde80d00498641","56c50628bdcde80d00498642","56c50628bdcde80d00498643","56c50628bdcde80d00498644","56c50628bdcde80d00498645","56c50628bdcde80d00498646","56c50628bdcde80d00498647","56c506a018f0c90d002808de","56c6b0baf795cf0d003ec13e","56fe58eb5a08190e00085149","571764513cf2960e0009a635","571fc008ffbc6a2000b25bb5","5739ca371f4b740e00b06e09","577522f197a3830e004bcc1b","57753d5ffecd260e00d86ce6","57adb71efaa7a10e004495b6"],"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z"},"__v":0,"parentDoc":null,"editedParams2":true,"editedParams":true,"createdAt":"2015-03-05T15:15:48.374Z"}

postAccount - log in

Use to log in into your account and receive your Account Key. Doesn't require passing API or Account Key.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

email:
required
string
Admin email
password:
required
string
Admin password

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Returns" } [/block] Information about Admin (account) and your `Account Key`.

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}