{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance_name/user/auth/","auth":"required","examples":{"codes":[{"name":"","code":"curl -X POST \\\n-H \"X-API-KEY: <API_KEY>\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"username\":\"geralt\",\n     \"password\":\"geralt\"}' \\\n\"https://api.syncano.io/v1.1/instances/<instance>/user/auth/\"","language":"curl"},{"code":"import syncano\n\nsyncano.connect(\n    api_key=\"API_KEY\",\n    instance_name=\"INSTANCE_NAME\",\n    username=\"Gordon Freeman\",\n    password=\"Black Mesa\"\n)\n","language":"python"},{"code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({apiKey: \"API_KEY\"});\nvar User = connection.User;\n\nvar query = {instanceName: \"INSTANCE_NAME\"};\nvar credentials = {email: \"EMAIL\", password: \"PASSWORD\"};\n\nUser.please().login(query, credentials).then(callback);","language":"javascript"}]},"method":"post","params":[{"name":"instance_name","type":"string","default":"","desc":"Instance name","required":true,"in":"path","ref":"","_id":"551d39773c66970d00d20bd2"},{"name":"username","type":"string","default":"","desc":"Name of your user","required":true,"in":"body","ref":"","_id":"551d37e3e52a0b23000c61b4"},{"name":"password","type":"string","default":"","desc":"Password of your user","required":true,"in":"body","ref":"","_id":"551d37e3e52a0b23000c61b3"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"username\": \"geralt\",\n  \"profile\": {\n    \"channel_room\": null,\n    \"group\": null,\n    \"links\": {\n      \"owner\": \"/v1.1/instances/rivia/users/9/\",\n      \"self\": \"/v1.1/instances/rivia/classes/user_profile/objects/33/\"\n    },\n    \"group_permissions\": \"none\",\n    \"created_at\": \"2016-03-11T18:29:54.051209Z\",\n    \"owner_permissions\": \"full\",\n    \"updated_at\": \"2016-03-11T18:29:54.051230Z\",\n    \"other_permissions\": \"none\",\n    \"owner\": 9,\n    \"id\": 33,\n    \"channel\": null,\n    \"revision\": 1\n  },\n  \"links\": {\n    \"profile\": \"/v1.1/instances/rivia/classes/user_profile/objects/33/\",\n    \"self\": \"/v1.1/instances/rivia/users/9/\",\n    \"groups\": \"/v1.1/instances/rivia/users/9/groups/\",\n    \"reset-key\": \"/v1.1/instances/rivia/users/9/reset_key/\"\n  },\n  \"user_key\": \"a262b3875566fb0d669ec8c22dafb648fbbea392\",\n  \"groups\": [],\n  \"id\": 9\n}","name":""},{"status":400,"language":"json","code":"{\n  \"detail\": \"JSON parse error - Expecting property name enclosed in double quotes: line 2 column 28 (char 49)\"\n}","name":""},{"status":401,"code":"{\n  \"detail\": \"Invalid username or password.\"\n}","language":"json"},{"code":"{\n  \"detail\": \"No such API Key.\"\n}","language":"json","status":403},{"code":"{\n  \"detail\": \"Instance was not found.\"\n}","language":"json","status":404}]},"settings":"56c50c06d1b8770d00922288"},"next":{"description":"","pages":[]},"title":"User - log in","type":"endpoint","slug":"user-log-in","excerpt":"","body":"Logs in your application users.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"body\": \"When using this endpoint, you should authenticate with an API Key. Using Account Key will work but for security reasons we strongly recommend that you use your API Key instead.\",\n  \"title\": \"API Key vs Account Key\"\n}\n[/block]","updates":[],"order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c50632bdcde80d004986b2","__v":0,"category":{"sync":{"isSync":false,"url":""},"pages":["56c50632bdcde80d004986b2","56c50632bdcde80d004986b3","56c50632bdcde80d004986b4","56c50632bdcde80d004986b5","56c50632bdcde80d004986b6"],"title":"User","slug":"user","order":16,"from_sync":false,"reference":true,"_id":"56c50628bdcde80d00498644","createdAt":"2015-04-02T12:24:37.714Z","project":"54774d9af3736008009e9e0e","version":"56c50626bdcde80d00498635","__v":1},"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"},"createdAt":"2015-04-02T12:25:12.357Z","editedParams2":true,"project":"54774d9af3736008009e9e0e","githubsync":"","editedParams":true,"parentDoc":null,"user":"54774c47f3736008009e9e0c"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Instance name

Body Params

username:
required
string
Name of your user
password:
required
string
Password of your user

Examples


Result Format


Documentation

Logs in your application users. [block:callout] { "type": "warning", "body": "When using this endpoint, you should authenticate with an API Key. Using Account Key will work but for security reasons we strongly recommend that you use your API Key instead.", "title": "API Key vs Account Key" } [/block]

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 }}