{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance_name/groups/:group_id/users/","auth":"required","examples":{"codes":[{"language":"curl","code":"curl -X POST \\\n-H \"X-API-KEY: <API_KEY>\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\"user\":\"<user_id>\"}' \\\n\"https://api.syncano.io/v1.1/instances/<instance_name>/groups/<group_id>/users/\"","name":""},{"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"},{"code":"// Planned for v1.1.0","language":"javascript"}]},"method":"post","params":[{"name":"instance_name","type":"string","default":"","desc":"Name of an instance.","required":true,"in":"path","ref":"","_id":"552e30172594f70d001b2c7e"},{"name":"group_id","type":"int","default":"","desc":"ID of a group","required":true,"in":"path","ref":"","_id":"552f92beb09eaf0d008deb4b"},{"name":"user","type":"int","default":"","desc":"ID of a user","required":true,"in":"body","ref":"","_id":"552f93e4b09eaf0d008deb4f"}],"results":{"codes":[{"name":"","code":"{\n  \"user\": {\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      {\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    ],\n    \"id\": 9\n  },\n  \"links\": {\n    \"self\": \"/v1.1/instances/rivia/groups/1/users/9/\"\n  }\n}","language":"json","status":200},{"code":"{\n  \"__all__\": [\n    \"Membership with this User and Group already exists.\"\n  ]\n}","language":"json","status":400,"name":""},{"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"},"next":{"description":"","pages":[]},"title":"Groups - Users - add","type":"endpoint","slug":"groups-users-add","excerpt":"","body":"Creates a user membership.","updates":[],"order":8,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c50635bdcde80d004986e0","__v":0,"category":{"sync":{"isSync":false,"url":""},"pages":["56c50635bdcde80d004986d8","56c50635bdcde80d004986d9","56c50635bdcde80d004986da","56c50635bdcde80d004986db","56c50635bdcde80d004986dc","56c50635bdcde80d004986dd","56c50635bdcde80d004986de","56c50635bdcde80d004986df","56c50635bdcde80d004986e0","56c50635bdcde80d004986e1"],"title":"Groups","slug":"groups","order":15,"from_sync":false,"reference":true,"_id":"56c50628bdcde80d00498643","version":"56c50626bdcde80d00498635","createdAt":"2015-04-15T09:29:39.602Z","project":"54774d9af3736008009e9e0e","__v":1},"editedParams":true,"editedParams2":true,"user":"54774c47f3736008009e9e0c","parentDoc":null,"project":"54774d9af3736008009e9e0e","createdAt":"2015-04-16T10:48:11.838Z","githubsync":"","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"}}

postGroups - Users - add


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

instance_name:
required
string
Name of an instance.
group_id:
required
integer
ID of a group

Body Params

user:
required
integer
ID of a user

Examples


Result Format


Documentation

Creates a user membership.

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