{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/instances/:instance_name/users/:user_id/groups/:group_id/","auth":"required","settings":"56c50c06d1b8770d00922288","examples":{"codes":[{"language":"curl","code":"curl -X DELETE \\\n-H \"X-API-KEY: <API_KEY>\" \\\n\"https://api.syncano.io/v1/instances/<instance_name>/users/<user_id>/groups/<group_id>/\"","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.remove_from_group(group_id=group.id)\n\n# or:\ngroup.delete_user(user_id=user.id)\n","language":"python"},{"language":"javascript","code":"// Planned for v1.1.0"}]},"method":"delete","params":[{"name":"instance_name","type":"string","default":"","desc":"Name of the instance that the application users belong to.","required":true,"in":"path","ref":"","_id":"552e06b95d4baa0d007835ee"},{"name":"user_id","type":"int","default":"","desc":"ID of a user.","required":true,"in":"path","ref":"","_id":"552e54182594f70d001b2cb8"},{"name":"group_id","type":"int","default":"","desc":"ID of a group","required":true,"in":"path","ref":"","_id":"552e59f506a32a0d009c2f28"}],"results":{"codes":[{"name":"","code":"(empty)","language":"json","status":204},{"language":"json","status":403,"code":"{\n  \"detail\": \"No such API Key.\"\n}"},{"status":404,"code":"{\n  \"detail\": \"Instance was not found.\"\n}","language":"json"}]}},"next":{"description":"","pages":[]},"title":"Users - Groups - delete","type":"endpoint","slug":"users-groups-delete","excerpt":"","body":"Delete a link to a group that given user belongs to.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Deleting a Group 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 Group itself won't be deleted.\"\n}\n[/block]","updates":[],"order":10,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56c50634bdcde80d004986ca","__v":0,"createdAt":"2015-04-15T12:44:43.253Z","editedParams":true,"parentDoc":null,"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"},"project":"54774d9af3736008009e9e0e","category":{"sync":{"isSync":false,"url":""},"pages":["56c50634bdcde80d004986c0","56c50634bdcde80d004986c1","56c50634bdcde80d004986c2","56c50634bdcde80d004986c3","56c50634bdcde80d004986c4","56c50634bdcde80d004986c5","56c50634bdcde80d004986c6","56c50634bdcde80d004986c7","56c50634bdcde80d004986c8","56c50634bdcde80d004986c9","56c50634bdcde80d004986ca"],"title":"Users","slug":"users","order":14,"from_sync":false,"reference":true,"_id":"56c50628bdcde80d00498642","project":"54774d9af3736008009e9e0e","__v":1,"createdAt":"2015-04-15T06:31:05.605Z","version":"56c50626bdcde80d00498635"},"editedParams2":true,"githubsync":"","user":"54774c47f3736008009e9e0c"}

deleteUsers - Groups - delete


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.
group_id:
required
integer
ID of a group

Examples


Result Format


Documentation

Delete a link to a group that given user belongs to. [block:callout] { "type": "info", "title": "Deleting a Group 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 Group 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 }}