{"_id":"56c50634bdcde80d004986c9","parentDoc":null,"user":"54774c47f3736008009e9e0c","githubsync":"","project":"54774d9af3736008009e9e0e","editedParams":true,"__v":0,"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"},"editedParams2":true,"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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-15T12:37:04.733Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  \"group\": {\n    \"description\": \"\",\n    \"id\": 1,\n    \"links\": {\n      \"self\": \"/v1.1/instances/rivia/groups/1/\",\n      \"users\": \"/v1.1/instances/rivia/groups/1/users/\"\n    },\n    \"label\": \"witchers\"\n  },\n  \"links\": {\n    \"self\": \"/v1.1/instances/rivia/users/1/groups/1/\"\n  }\n}","language":"json","status":201},{"name":"","code":"{\n  \"group\": [\n    \"Incorrect type.  Expected pk value, received unicode.\"\n  ]\n}","language":"json","status":400},{"code":"{\n  \"detail\": \"No such API Key.\"\n}","language":"json","status":403},{"status":404,"code":"{\n  \"detail\": \"Instance was not found.\"\n}","language":"json"}]},"settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"language":"curl","code":"curl -X POST \\\n-H \"X-API-KEY: <API_KEY>\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"group\":<group_id>}' \\\n\"https://api.syncano.io/v1.1/instances/<instance_name>/users/<user_id>/groups/\"\n","name":""},{"language":"javascript","code":"var Syncano = require(\"syncano\");\nvar connection = Syncano({accountKey: \"ACCOUNT_KEY\"});\nvar Group = connection.Group;\nvar User = connection.User;\n\n// via Group model\n\nvar query = { id: GROUP_ID, instanceName: \"MY_INSTANCE\" };\nvar user = { user: USER_ID };\n\nGroup.please().addUser(query, user);\n\n// via User Model\n\nvar query = { instanceName: \"MY_INSTANCE\", user: USER_ID };\nvar group = { group: GROUP_ID };\n\nUser.please().addGroup(query, group);"},{"code":"import syncano\nfrom syncano.models import Group, User\n\nconnection = syncano.connect(api_key=\"ACCOUNT_KEY\", instance_name=\"INSTANCE_NAME\")\n\nuser = User.please.get(id=USER_ID)\ngroup = Group.please.get(id=GROUP_ID)\nuser.add_to_group(group_id=group.id)\n\n# or:\ngroup.add_user(user_id=user.id)\n","language":"python","name":"Python"}]},"method":"post","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":"552e54182594f70d001b2cb8","ref":"","in":"path","required":true,"desc":"ID of a user.","default":"","type":"int","name":"user_id"},{"_id":"552e5c06a702770d00d96dee","ref":"","in":"body","required":true,"desc":"ID of a group.","default":"","type":"int","name":"group"}],"url":"/instances/:instance_name/users/:user_id/groups/"},"isReference":true,"order":9,"body":"Create a link between a user and a group.","excerpt":"","slug":"users-groups-add","type":"endpoint","title":"Users - Groups - add"}

postUsers - Groups - add


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Name of the instance that the application users belong to.
user_id:
required
integer
ID of a user.

Body Params

group:
required
integer
ID of a group.

Examples


Result Format


Documentation

Create a link between a user and a group.

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