Removing a user or group from a role for a folderSince 8/2015
Added by IBM contributorElizabeth Bowling | Edited by IBM contributorElizabeth Bowling on August 21, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Delete a specified user or group from the all access roles for a particular folder.

This API removes all access to the specified folder because it deletes the user from all roles.

This method requires authentication.

To remove a user or group from an access role, the currently authenticated user must be either: the owner of the folder, an administrator, or a user who has received appropriate permission on the folder through the Manager access role. To test whether the current user can remove a user or group from a role, use the API for Retrieving the list of members for a folder's role to see if the user belongs to the Manager Role.

The following error codes could appear in a response body for an invalid request:

Error Code Description
Unknown Returned when the cause of an error is unknown
AccessDenied Returned when the cause of an error is due to a permission restriction
ItemNotFound Returned when the cause of an error is related to a resource not being found
Input
Method URI Description
DELETE /files/{auth}/api/collection/{collection-id}/roles/{role-type}/members/{member-id} Delete the specified user from the specified access role for the specified folder.
DELETE /files/{auth}/api/communitycollection/{community-id}/roles/{role-type}/members/{member-id} Delete the specified user from the specified access role for the specified community folder.
Name Type Optional Description
auth
enumerated No The authorization protocol being used by your application to access Connections Cloud.
Authorized values:
  • basic
  • oauth
collection-id
string No The UUID of the folder where the user's access is being removed.
community-id
string No The UUID of the community folder where the user's access is being removed.
role-type
enumerated No The name of the role to which the user currently has access.
Authorized values:
  • reader
  • contributor
  • manager
member-id
string No The ID of the user who is being removed from the access roles.
Name Type Optional Description
Authorization
enumerated No The authentication mechanism selected by your application to access the API.
Basic is the Base64 encoding of the IBM Connections Cloud username and password: Base64(username:password). For example, Base64(twatson@us.ibm.com:password).
Bearer is the oauth 2.0 access token that is generated when the user grants your application access to IBM Connections Cloud services.
See the reference topic "OAuth 2.0 APIs for web server flow" for more information.
Authorized values:
  • basic
  • bearer
Output
Code Description
204
The operation was successful.
401
Unauthorized. Returned when no authenticated user or no userid, email, or key parameter are provided on the request.
Examples
Remove the specified user, who currently as Contributor access to the folder, from all access roles for the specified folder. A successful operation returns response code 204.
DELETE /files/basic/api/collection/b7659c6f-af22-45d2-90b8-b5162561229f/roles/contributor/members/aberzat HTTP/1.1

Response returned by the server
HTTP/1.1 204 No Content

X-LCONN-API-IMCOMPITABLE: api