{"id":"56bc8e679afb8b0d00d62dcf","name":"Buddy Platform Limited","subdomain":"buddydocs","versions":[{"_id":"56bc8e689afb8b0d00d62dd2","releaseDate":"2016-02-11T13:36:40.146Z","is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},{"_id":"56f46249ab3f610e000a63e9","releaseDate":"2016-03-24T21:55:21.557Z","is_deprecated":false,"is_hidden":true,"is_beta":true,"is_stable":false,"codename":"MQTT","version_clean":"1.1.0","version":"1.1"}],"current_version":{"version_clean":"1.0.0","version":"1.0"},"oauth":{"enabled":false},"api":{"name":"","url":"","contenttype":"form","auth":"","explorer":true,"proxyEnabled":true,"jwt":false,"authextra":[],"headers":[],"object_definitions":[]},"apiAlt":[],"plan_details":{"name":"Business","is_active":true,"cost":199,"versions":10000,"custom_domain":true,"custom_pages":true,"whitelabel":true,"errors":true,"password":true,"landing_page":true,"themebuilder":true,"stylesheet":true,"javascript":true,"html":true,"extra_html":true,"admins":true},"intercom":"","intercom_secure_emailonly":false,"flags":{"allow_hub2":false,"hub2":false,"migrationRun":true,"oauth":false,"swagger":false,"correctnewlines":false,"speedyRender":false,"allowXFrame":false,"jwt":false,"hideGoogleAnalytics":false,"stripe":false,"disableDiscuss":false,"newApiExplorer":false},"asset_base_url":""}

{"_id":"56c4196434df460d00c2bece","user":"56b98db7bb36440d0001f492","category":{"_id":"56c4181cc4796b0d007ef039","version":"56bc8e689afb8b0d00d62dd2","__v":26,"project":"56bc8e679afb8b0d00d62dcf","pages":["56c4192dbc41330d009f25fd","56c4196434df460d00c2bece","56c419814f0aed1700afaba6","56c4198dbc41330d009f25ff","56c419962e75e01700986053","56c4199f54b6030d00ec29a4","56c419a8bb64720d00552b8b","56c419b1bb64720d00552b8d","56c419b92d97560d00e23cf9","56c419c64040602b0064cea3","56c419d4bc41330d009f2601","56c419de70187b17005f43b9","56c419ea6063071700500cfe","56c419fa54b6030d00ec29a6","56c41a096063071700500d00","56c41a1834df460d00c2bed0","56c41a773d30210d00ea8517","56c41a86c4796b0d007ef03e","56c41a904f0aed1700afaba8","56c41a9fbc41330d009f2603","56c41aaa521f350d00d348fe","56c41abb4040602b0064cea5","56c41ad24040602b0064cea7","56c41ade48213b1700af6e28","56c41aeb3d30210d00ea8519","56c41af948213b1700af6e2a"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-17T06:50:04.339Z","from_sync":false,"order":2,"slug":"users","title":"Users"},"project":"56bc8e679afb8b0d00d62dcf","version":{"_id":"56bc8e689afb8b0d00d62dd2","project":"56bc8e679afb8b0d00d62dcf","__v":18,"createdAt":"2016-02-11T13:36:40.146Z","releaseDate":"2016-02-11T13:36:40.146Z","categories":["56bc8e689afb8b0d00d62dd3","56c3c837bc41330d009f25ed","56c3c83e521f350d00d348eb","56c3c8452d97560d00e23cd8","56c3c85234df460d00c2beb8","56c4180d70187b17005f43b4","56c418162d97560d00e23cf6","56c4181cc4796b0d007ef039","56c4182370187b17005f43b5","56c418292e75e01700986052","56c4183328bd680d005e7ac6","56c4183bbb64720d00552b88","56c418414040602b0064cea0","56c4184754b6030d00ec29a1","56c4184c28bd680d005e7ac7","56c4185370187b17005f43b6","56c4185b6063071700500cfc","582a98b6f8c0a0190053d7a5"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":9,"parentDoc":null,"githubsync":"","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-17T06:55:32.415Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"/users/login\"\n}\n[/block]\nLogs the user into the application.  Once a user is logged in they will have access to any API calls that require user permissions.\n\nUsers must log in using their username and password.  A successful response will return the user's Buddy profile.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Buddy.loginUser(\\\"username\\\", \\\"password\\\", new BuddyCallback<User>(User.class) {\\n\\t:::at:::Override\\n\\tpublic void completed(BuddyResult<User> result) {\\n\\t\\t// Your callback code here\\n\\t}\\n});\",\n      \"language\": \"javascript\"\n    },\n    {\n      \"code\": \"Buddy.loginUser(\\\"username\\\", \\\"password\\\", new BuddyCallback<User>(User.class) {\\n\\[email protected]\\n\\tpublic void completed(BuddyResult<User> result) {\\n\\t\\t// Your callback code here\\n\\t}\\n});\",\n      \"language\": \"objectivec\",\n      \"name\": \"iOS\"\n    },\n    {\n      \"code\": \"Buddy.loginUser(\\\"username\\\", \\\"password\\\", new BuddyCallback<User>(User.class) {\\n\\[email protected]\\n\\tpublic void completed(BuddyResult<User> result) {\\n\\t\\t// Your callback code here\\n\\t}\\n});\",\n      \"language\": \"java\",\n      \"name\": \"Android\"\n    },\n    {\n      \"code\": \"var result = await Buddy.LoginUserAsync(username, password);\",\n      \"language\": \"csharp\",\n      \"name\": \".NET\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Body Parameters\n\nThese parameters should be specified as part of the request body.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"userName\",\n    \"1-0\": \"password\",\n    \"0-1\": \"A username to identify the user's account. The value must be unique for the application's user base (i.e. duplicate usernames are prohibited across the same application).\",\n    \"1-1\": \"A password to assign to this user (e.g. a password entered by the user during signup). The password will be used in subsequent calls to the login endpoint.\",\n    \"0-2\": \"string\",\n    \"1-2\": \"string\",\n    \"0-3\": \"Optional\",\n    \"1-3\": \"Required\"\n  },\n  \"cols\": 4,\n  \"rows\": 2\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"status\\\": 200,\\n    \\\"result\\\": {\\n        \\\"celebMode\\\": false,\\n        \\\"locationFuzzing\\\": false,\\n        \\\"accessToken\\\": \\\"[access token>]\\\",\\n        \\\"accessTokenExpires\\\": \\\"/Date(1423000550423)/\\\",\\n        \\\"firstName\\\": \\\"Test First\\\",\\n        \\\"lastName\\\": \\\"Test last\\\",\\n        \\\"dateOfBirth\\\": \\\"/Date(206841600000)/\\\",\\n        \\\"lastLogin\\\": \\\"/Date(1391456107750)/\\\",\\n        \\\"email\\\": \\\"[email protected]\\\",\\n        \\\"userName\\\": \\\"TestUserForBuddy\\\",\\n        \\\"id\\\": \\\"bv.cphbvgcHsPch\\\",\\n        \\\"created\\\": \\\"/Date(1391456107590)/\\\",\\n        \\\"lastModified\\\": \\\"/Date(1391456107750)/\\\"\\n    },\\n    \\\"request_id\\\": \\\"6b8b6a7b-b133-4377-be89-5b37fce5bf2e\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Response\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"user-login","type":"basic","title":"User Login"}

User Login

[block:api-header] { "type": "post", "title": "/users/login" } [/block] Logs the user into the application. Once a user is logged in they will have access to any API calls that require user permissions. Users must log in using their username and password. A successful response will return the user's Buddy profile. [block:code] { "codes": [ { "code": "Buddy.loginUser(\"username\", \"password\", new BuddyCallback<User>(User.class) {\n\[email protected]\n\tpublic void completed(BuddyResult<User> result) {\n\t\t// Your callback code here\n\t}\n});", "language": "javascript" }, { "code": "Buddy.loginUser(\"username\", \"password\", new BuddyCallback<User>(User.class) {\n\[email protected]\n\tpublic void completed(BuddyResult<User> result) {\n\t\t// Your callback code here\n\t}\n});", "language": "objectivec", "name": "iOS" }, { "code": "Buddy.loginUser(\"username\", \"password\", new BuddyCallback<User>(User.class) {\n\[email protected]\n\tpublic void completed(BuddyResult<User> result) {\n\t\t// Your callback code here\n\t}\n});", "language": "java", "name": "Android" }, { "code": "var result = await Buddy.LoginUserAsync(username, password);", "language": "csharp", "name": ".NET" } ], "sidebar": true } [/block] ###Body Parameters These parameters should be specified as part of the request body. [block:parameters] { "data": { "0-0": "userName", "1-0": "password", "0-1": "A username to identify the user's account. The value must be unique for the application's user base (i.e. duplicate usernames are prohibited across the same application).", "1-1": "A password to assign to this user (e.g. a password entered by the user during signup). The password will be used in subsequent calls to the login endpoint.", "0-2": "string", "1-2": "string", "0-3": "Optional", "1-3": "Required" }, "cols": 4, "rows": 2 } [/block] [block:code] { "codes": [ { "code": "{\n \"status\": 200,\n \"result\": {\n \"celebMode\": false,\n \"locationFuzzing\": false,\n \"accessToken\": \"[access token>]\",\n \"accessTokenExpires\": \"/Date(1423000550423)/\",\n \"firstName\": \"Test First\",\n \"lastName\": \"Test last\",\n \"dateOfBirth\": \"/Date(206841600000)/\",\n \"lastLogin\": \"/Date(1391456107750)/\",\n \"email\": \"[email protected]\",\n \"userName\": \"TestUserForBuddy\",\n \"id\": \"bv.cphbvgcHsPch\",\n \"created\": \"/Date(1391456107590)/\",\n \"lastModified\": \"/Date(1391456107750)/\"\n },\n \"request_id\": \"6b8b6a7b-b133-4377-be89-5b37fce5bf2e\"\n}", "language": "json", "name": "Response" } ], "sidebar": true } [/block]