groups/{groupid}/users/{userid} (DELETE)

Overview

Remove given member from a group

REST Method: DELETE
Method Access: public

Uri Parameters

Name	Type	Description
userid	string	either an integer user ID, "current", or "=" followed by a double uri-encoded user name
groupid	string	either an integer group ID or "=" followed by a double uri-encoded group name

Query Parameters

Name	Type	Description
authenticate	bool?	Force authentication for request (default: false)

Return Codes

Name	Value	Description
OK	200	Request completed successfully
Bad Request	400	Invalid input parameter
Forbidden	403	Administrator access is required
Not Found	404	Requested group could not be found

Message Format

Input:

Empty body

Output:


<group id="{int}" href="{uri}">
    <groupname>{text}</groupname> 
    <service.authentication id="{int}" href="{uri}" /> 
    <users count="{int}" href="{uri}" /> 
    <permissions.group>
        <operations mask="{int}">{text}</operations> 
        <role id="{int}" href="{uri}">{text}</role> 
    </permissions.group>
</group>

Implementation Notes

The user specified in the URI will be removed from the group members list

Curl Code Sample: Remove a User from a Group

The following command removes user "foo" from group "bar":

Sample Code

curl -u admin:password -X DELETE -i http://mindtouch.address/@api/deki/groups/=bar/users/=foo

Implementation notes

curl flags

-u: Provides external user authentication.
-X: Specifies the HTTP request method.
-i: Outputs the HTTP response headers. Useful for debugging.

Permissions

ADMIN permission is required to execute above command.