{"_id":"56c50635bdcde80d004986e1","project":"54774d9af3736008009e9e0e","user":"54774c47f3736008009e9e0c","__v":0,"githubsync":"","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"},"parentDoc":null,"category":{"_id":"56c50628bdcde80d00498643","pages":["56c50635bdcde80d004986d8","56c50635bdcde80d004986d9","56c50635bdcde80d004986da","56c50635bdcde80d004986db","56c50635bdcde80d004986dc","56c50635bdcde80d004986dd","56c50635bdcde80d004986de","56c50635bdcde80d004986df","56c50635bdcde80d004986e0","56c50635bdcde80d004986e1"],"version":"56c50626bdcde80d00498635","project":"54774d9af3736008009e9e0e","__v":1,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-04-15T09:29:39.602Z","from_sync":false,"order":15,"slug":"groups","title":"Groups"},"editedParams":true,"editedParams2":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-16T10:54:28.433Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","code":"curl -X DELETE \\\n-H \"X-API-KEY: <API_KEY>\" \\\n\"https://api.syncano.io/v1.1/instances/<instance_name>/groups/<group_id>/users/<user_id>/\"","language":"curl"},{"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.remove_from_group(group_id=group.id)\n\n# or:\ngroup.delete_user(user_id=user.id)\n","language":"python"},{"code":"// Planned for v1.1.0","language":"javascript"}]},"method":"delete","results":{"codes":[{"code":"(empty)","name":"","status":204,"language":"json"},{"code":"{\n  \"detail\": \"No such API Key.\"\n}","status":403,"language":"json"},{"status":404,"language":"json","code":"{\n  \"detail\": \"Not found\"\n}"}]},"settings":"56c50c06d1b8770d00922288","auth":"required","params":[{"_id":"552e30172594f70d001b2c7e","ref":"","in":"path","required":true,"desc":"Name of an instance.","default":"","type":"string","name":"instance_name"},{"_id":"552f92beb09eaf0d008deb4b","ref":"","in":"path","required":true,"desc":"ID of a group.","default":"","type":"int","name":"group_id"},{"_id":"552f9347633a5b0d00e99dc2","ref":"","in":"path","required":true,"desc":"ID of a user.","default":"","type":"int","name":"user_id"}],"url":"/instances/:instance_name/groups/:group_id/users/:user_id/"},"isReference":true,"order":9,"body":"Deletes a link to a User that was part of a given Group.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Deleting a User Membership\",\n  \"body\": \"By using this endpoint, you delete only a group membership - the link between a group and a user. End effect is that the User is removed from the Group. The User itself won't be deleted.\"\n}\n[/block]","excerpt":"","slug":"groups-users-delete","type":"endpoint","title":"Groups - Users - delete"}

deleteGroups - Users - delete


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.
user_id:
required
integer
ID of a user.

Examples


Result Format


Documentation

Deletes a link to a User that was part of a given Group. [block:callout] { "type": "info", "title": "Deleting a User Membership", "body": "By using this endpoint, you delete only a group membership - the link between a group and a user. End effect is that the User is removed from the Group. The User itself won't be deleted." } [/block]

User Information

Try It Out

delete
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}