{"_id":"56c50634bdcde80d004986c2","editedParams2":true,"user":"54774c47f3736008009e9e0c","category":{"_id":"56c50628bdcde80d00498642","project":"54774d9af3736008009e9e0e","__v":1,"version":"56c50626bdcde80d00498635","pages":["56c50634bdcde80d004986c0","56c50634bdcde80d004986c1","56c50634bdcde80d004986c2","56c50634bdcde80d004986c3","56c50634bdcde80d004986c4","56c50634bdcde80d004986c5","56c50634bdcde80d004986c6","56c50634bdcde80d004986c7","56c50634bdcde80d004986c8","56c50634bdcde80d004986c9","56c50634bdcde80d004986ca"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-04-15T06:31:05.605Z","from_sync":false,"order":14,"slug":"users","title":"Users"},"editedParams":true,"githubsync":"","parentDoc":null,"version":{"_id":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":10,"createdAt":"2016-02-17T23:45:42.869Z","releaseDate":"2016-02-17T23:45:42.869Z","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"],"is_deprecated":true,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"API v1.1","version_clean":"0.1.1","version":"0.1.1"},"__v":0,"project":"54774d9af3736008009e9e0e","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-15T06:48:09.824Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","code":"curl -X POST \\\n-H \"X-API-KEY: <API_KEY>\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"username\":\"<username>\",\n     \"password\":\"<password>\"}' \\\n\"https://api.syncano.io/v1.1/instances/<instance_name>/users/\"","language":"curl"},{"code":"import syncano\nfrom syncano.models import User\n\nsyncano.connect(api_key=\"API_KEY_WITH_ALLOW_USER_CREATE_FLAG\", instance_name=\"INSTANCE_NAME\") \n# You can use an account key as well\n\nnew_user = User.please.create(\n    username=\"USER_NAME\",\n    password=\"PASSWORD\"\n)\n","language":"python"},{"code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({apiKey: \"API_KEY_WITH_ALLOW_USER_CREATE_FLAG\"});\nvar User = connection.User;\n\nvar options = {\n  username: USERNAME, \n  password: PASSWORD,\n  instanceName: INSTANCE_NAME\n};\n\nUser.please().create(options).then(callback);","language":"javascript"}]},"method":"post","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/10/\",\n      \"self\": \"/v1.1/instances/rivia/classes/user_profile/objects/37/\"\n    },\n    \"group_permissions\": \"none\",\n    \"created_at\": \"2016-03-17T17:56:31.181939Z\",\n    \"owner_permissions\": \"full\",\n    \"updated_at\": \"2016-03-17T17:56:31.181957Z\",\n    \"other_permissions\": \"none\",\n    \"owner\": 10,\n    \"id\": 37,\n    \"channel\": null,\n    \"revision\": 1\n  },\n  \"links\": {\n    \"profile\": \"/v1.1/instances/rivia/classes/user_profile/objects/37/\",\n    \"self\": \"/v1.1/instances/rivia/users/10/\",\n    \"groups\": \"/v1.1/instances/rivia/users/10/groups/\",\n    \"reset-key\": \"/v1.1/instances/rivia/users/10/reset_key/\"\n  },\n  \"user_key\": \"12h46d960dbf3ec62da2dea6bcasd1aade6sqv24388\",\n  \"groups\": [],\n  \"id\": 10\n}","name":""},{"status":400,"language":"json","code":"{\n  \"password\": [\n    \"This field is required.\"\n  ]\n}","name":""},{"status":403,"language":"json","code":"{\n  \"detail\": \"No such API Key.\"\n}"},{"status":404,"language":"json","code":"{\n  \"detail\": \"Instance was not found.\"\n}"}]},"settings":"56c50c06d1b8770d00922288","auth":"required","params":[{"_id":"552e06b95d4baa0d007835ee","ref":"","in":"path","required":true,"desc":"Name of the instance that the application users belong to.","default":"","type":"string","name":"instance_name"},{"_id":"552e09a906a32a0d009c2eb5","ref":"","in":"body","required":true,"desc":"Username of the new user.","default":"","type":"string","name":"username"},{"_id":"552e09a906a32a0d009c2eb4","ref":"","in":"body","required":true,"desc":"Password of the new user.","default":"","type":"string","name":"password"}],"url":"/instances/:instance_name/users/"},"isReference":true,"order":2,"body":"Add a new user to a given instance.","excerpt":"","slug":"users-add","type":"endpoint","title":"Users - add"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Name of the instance that the application users belong to.

Body Params

username:
required
string
Username of the new user.
password:
required
string
Password of the new user.

Examples


Result Format


Documentation

Add a new user to a given instance.

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