{"_id":"56c4192dbc41330d009f25fd","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"},"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"},"githubsync":"","user":"56b98db7bb36440d0001f492","parentDoc":null,"__v":9,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-17T06:54:37.911Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"/users\"\n}\n[/block]\nCreates a new user on Buddy and returns the created user object.\n\nThe only required user values are `username` and `password`. It is up to application to gather any additional user information.  \n\n**Note:** `email` is an important field to allow the user to receive support emails such as password reset. If an email is specified, Buddy can automatically send a user a password reset email on your behalf. See the **Settings** section of your application's dashboard for details.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\nvar options = {\\n\\tuserName: \\\"SuperBuddy\\\",\\n\\tpassword: \\\"p4ssw0rd\\\",\\n\\temail: \\\"support:::at:::buddy.com\\\",\\n\\tfirstName: \\\"First\\\",\\n\\tlastName: \\\"Last\\\",\\n\\tprofilePictureID: \\\"bvc.bCkbbffnqbvq\\\",\\n\\tgender: \\\"Unknown\\\",\\n\\tdateOfBirth: \\\"2014/05/06\\\",\\n\\tlocation: \\\"47.1, -121.292\\\",\\n\\ttag: \\\"Some useful tag\\\",\\n\\tlocationFuzz: true\\n};\\n\\nBuddy.createUser(options,\\n\\t\\tfunction(err, result) {\\n\\t\\t\\t \\n\\t\\t\\tif (result.success) {\\n\\t\\t\\t\\t// Do something with the result!\\n\\t\\t\\t} else { \\n\\t\\t\\t\\t// Otherwise log the error\\n\\t\\t\\t\\tconsole.log(err); \\n\\t\\t\\t} \\n\\t\\t}\\n\\t);\",\n      \"language\": \"javascript\"\n    },\n    {\n      \"code\": \"[Buddy createUser:@\\\"username\\\"\\n\\tpassword:@\\\"password\\\"\\n\\tfirstName:@\\\"Firstname\\\"\\n\\tlastName:@\\\"Lastname\\\"\\n\\temail:@\\\"[email protected]\\\"\\n\\tdateOfBirth:nil\\n\\tgender:nil\\n\\ttag:nil\\n\\tcallback:^(id obj, NSError *error) {\\n\\t// Your callback code here\\n}];\",\n      \"language\": \"objectivec\",\n      \"name\": \"iOS\"\n    },\n    {\n      \"code\": \"Buddy.createUser(\\\"username\\\",\\n\\t\\t\\\"password\\\",\\n\\t\\t\\\"Firstname\\\",\\n\\t\\t\\\"Lastname\\\",\\n\\t\\t\\\"[email protected]\\\",\\n\\t\\tbirthday,\\n\\t\\tgender,\\n\\t\\t\\\"tag\\\", 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.CreateUserAsync(username, password, firstName, lastName, email, gender, dateOfBirth, tag);\",\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    \"2-0\": \"email\",\n    \"3-0\": \"firstName\",\n    \"4-0\": \"lastName\",\n    \"5-0\": \"profilePictureID\",\n    \"6-0\": \"gender\",\n    \"7-0\": \"dateOfBirth\",\n    \"8-0\": \"location\",\n    \"9-0\": \"tag\",\n    \"10-0\": \"locationFuzz\",\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    \"2-1\": \"A valid email address to associate with the user's account. Like the user name, the email address must also be unique. Note: an email address is required to utilize the Request Password Reset API.\",\n    \"3-1\": \"The user's first or given name.\",\n    \"4-1\": \"The user's last or family name.\",\n    \"5-1\": \"The ID of the picture representing a user in your application.\",\n    \"6-1\": \"The gender to search by: \\\"Male\\\", \\\"Female\\\", or \\\"Unknown\\\".\",\n    \"7-1\": \"The date/time of the user's birthday. Valid date formats include UTC timestamps specified as Unix ticks (milliseconds since Jan 1, 1970 UTC) such as \\\"1398816000000\\\" and common date formats such as \\\"2014/5/6\\\".\",\n    \"8-1\": \"A location value, passed as a string in the format \\\"{latitude},{longitude}\\\" (e.g. \\\"47.1,-121.292\\\").\",\n    \"9-1\": \"A string value to attach to this object. This value will be returned with the object as a property called tag.\",\n    \"10-1\": \"Set to \\\"true\\\" to make the user's location less accurate. Defaults to \\\"false\\\".\",\n    \"0-2\": \"string\",\n    \"1-2\": \"string\",\n    \"2-2\": \"string\",\n    \"3-2\": \"string\",\n    \"4-2\": \"string\",\n    \"6-2\": \"string\",\n    \"7-2\": \"string\",\n    \"8-2\": \"string\",\n    \"9-2\": \"string\",\n    \"10-2\": \"string\",\n    \"5-2\": \"buddyId\",\n    \"1-3\": \"Required\",\n    \"0-3\": \"Optional\",\n    \"2-3\": \"Optional\",\n    \"3-3\": \"Optional\",\n    \"4-3\": \"Optional\",\n    \"5-3\": \"Optional\",\n    \"6-3\": \"Optional\",\n    \"7-3\": \"Optional\",\n    \"8-3\": \"Optional\",\n    \"9-3\": \"Optional\",\n    \"10-3\": \"Optional\"\n  },\n  \"cols\": 4,\n  \"rows\": 11\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"status\\\": 200,\\n    \\\"result\\\": {\\n        \\\"locationFuzzing\\\": false,\\n        \\\"gender\\\": \\\"Male\\\",\\n        \\\"firstName\\\": \\\"John\\\",\\n        \\\"lastName\\\": \\\"Doe\\\",\\n        \\\"lastLogin\\\": \\\"/Date(1389315936903)/\\\",\\n        \\\"email\\\": \\\"[email protected]\\\",\\n        \\\"userName\\\": \\\"someone\\\",\\n        \\\"id\\\": \\\"ai.4NbanNUPgi\\\",\\n        \\\"created\\\": \\\"/Date(1389315936693)/\\\",\\n        \\\"lastModified\\\": \\\"/Date(1389315936903)/\\\",\\n        \\\"accessToken\\\": \\\"[access token]\\\",\\n        \\\"accessTokenExpires\\\": \\\"/Date(1389315936903)/\\\",\\n        \\\"profilePictureID\\\" : \\\"bv.crtJMKgqgLxK\\\",\\n        \\\"profilePictureUrl\\\" : \\\"http://api-us.buddyplatform.com/pictures/bvc.crtJMKgqgLxK/file?sig=9fb3488ed60295d9c2a26012ccdedd71579a7cd34fe244ac530cdcd25671816b&sigValues=eyJwYXJhbXMiOnt9LCJwTGlzdCI6W10sInQiOm51bGwsImFjSWQiOiJiYmJidi5tcnRKTXR0TGdudksiLCJhcElkIjoiYmJiYmJjLnBydEpNbnRjaG52SyIsInVJZCI6ImJ2LkNydEpNS2dxZ0x4SyJ9\\\"\\n    },\\n    \\\"request_id\\\": \\\"0877f303-1177-48eb-8e61-e6414b728fb3\\\",\\n    \\\"success\\\": true\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Response\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"create-user","type":"basic","title":"Create User"}
[block:api-header] { "type": "post", "title": "/users" } [/block] Creates a new user on Buddy and returns the created user object. The only required user values are `username` and `password`. It is up to application to gather any additional user information. **Note:** `email` is an important field to allow the user to receive support emails such as password reset. If an email is specified, Buddy can automatically send a user a password reset email on your behalf. See the **Settings** section of your application's dashboard for details. [block:code] { "codes": [ { "code": "\nvar options = {\n\tuserName: \"SuperBuddy\",\n\tpassword: \"p4ssw0rd\",\n\temail: \"[email protected]\",\n\tfirstName: \"First\",\n\tlastName: \"Last\",\n\tprofilePictureID: \"bvc.bCkbbffnqbvq\",\n\tgender: \"Unknown\",\n\tdateOfBirth: \"2014/05/06\",\n\tlocation: \"47.1, -121.292\",\n\ttag: \"Some useful tag\",\n\tlocationFuzz: true\n};\n\nBuddy.createUser(options,\n\t\tfunction(err, result) {\n\t\t\t \n\t\t\tif (result.success) {\n\t\t\t\t// Do something with the result!\n\t\t\t} else { \n\t\t\t\t// Otherwise log the error\n\t\t\t\tconsole.log(err); \n\t\t\t} \n\t\t}\n\t);", "language": "javascript" }, { "code": "[Buddy createUser:@\"username\"\n\tpassword:@\"password\"\n\tfirstName:@\"Firstname\"\n\tlastName:@\"Lastname\"\n\temail:@\"[email protected]\"\n\tdateOfBirth:nil\n\tgender:nil\n\ttag:nil\n\tcallback:^(id obj, NSError *error) {\n\t// Your callback code here\n}];", "language": "objectivec", "name": "iOS" }, { "code": "Buddy.createUser(\"username\",\n\t\t\"password\",\n\t\t\"Firstname\",\n\t\t\"Lastname\",\n\t\t\"[email protected]\",\n\t\tbirthday,\n\t\tgender,\n\t\t\"tag\", 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.CreateUserAsync(username, password, firstName, lastName, email, gender, dateOfBirth, tag);", "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", "2-0": "email", "3-0": "firstName", "4-0": "lastName", "5-0": "profilePictureID", "6-0": "gender", "7-0": "dateOfBirth", "8-0": "location", "9-0": "tag", "10-0": "locationFuzz", "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.", "2-1": "A valid email address to associate with the user's account. Like the user name, the email address must also be unique. Note: an email address is required to utilize the Request Password Reset API.", "3-1": "The user's first or given name.", "4-1": "The user's last or family name.", "5-1": "The ID of the picture representing a user in your application.", "6-1": "The gender to search by: \"Male\", \"Female\", or \"Unknown\".", "7-1": "The date/time of the user's birthday. Valid date formats include UTC timestamps specified as Unix ticks (milliseconds since Jan 1, 1970 UTC) such as \"1398816000000\" and common date formats such as \"2014/5/6\".", "8-1": "A location value, passed as a string in the format \"{latitude},{longitude}\" (e.g. \"47.1,-121.292\").", "9-1": "A string value to attach to this object. This value will be returned with the object as a property called tag.", "10-1": "Set to \"true\" to make the user's location less accurate. Defaults to \"false\".", "0-2": "string", "1-2": "string", "2-2": "string", "3-2": "string", "4-2": "string", "6-2": "string", "7-2": "string", "8-2": "string", "9-2": "string", "10-2": "string", "5-2": "buddyId", "1-3": "Required", "0-3": "Optional", "2-3": "Optional", "3-3": "Optional", "4-3": "Optional", "5-3": "Optional", "6-3": "Optional", "7-3": "Optional", "8-3": "Optional", "9-3": "Optional", "10-3": "Optional" }, "cols": 4, "rows": 11 } [/block] [block:code] { "codes": [ { "code": "{\n \"status\": 200,\n \"result\": {\n \"locationFuzzing\": false,\n \"gender\": \"Male\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"lastLogin\": \"/Date(1389315936903)/\",\n \"email\": \"[email protected]\",\n \"userName\": \"someone\",\n \"id\": \"ai.4NbanNUPgi\",\n \"created\": \"/Date(1389315936693)/\",\n \"lastModified\": \"/Date(1389315936903)/\",\n \"accessToken\": \"[access token]\",\n \"accessTokenExpires\": \"/Date(1389315936903)/\",\n \"profilePictureID\" : \"bv.crtJMKgqgLxK\",\n \"profilePictureUrl\" : \"http://api-us.buddyplatform.com/pictures/bvc.crtJMKgqgLxK/file?sig=9fb3488ed60295d9c2a26012ccdedd71579a7cd34fe244ac530cdcd25671816b&sigValues=eyJwYXJhbXMiOnt9LCJwTGlzdCI6W10sInQiOm51bGwsImFjSWQiOiJiYmJidi5tcnRKTXR0TGdudksiLCJhcElkIjoiYmJiYmJjLnBydEpNbnRjaG52SyIsInVJZCI6ImJ2LkNydEpNS2dxZ0x4SyJ9\"\n },\n \"request_id\": \"0877f303-1177-48eb-8e61-e6414b728fb3\",\n \"success\": true\n}", "language": "json", "name": "Response" } ], "sidebar": true } [/block]