Loading ...

REST API: Delete All Space Roles of User | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Spaces » REST API: Space Roles » REST API: Delete All Space Roles of User
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 2

REST API: Delete All Space Roles of User

0 
 /5
0 (0votes)

Delete all space roles of user

DELETE /api/users/{UserID}/spaces/{SpaceID}/roles

Remove all the space roles of a specific user. Returns JSON indicating whether or not the roles removal was successful. Valid for Communifire version 6.0 and above.

Please Note All space roles will be removed from the user, including the space Member role.

Method Details

HTTP Method
DELETE
Response Format
JSON
Requires Authentication?
YES
Product Version
6.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)		 Communifire REST API key for the Communifire portal you are making the call for.
UserID Used in the request URL (see above) Unique ID of the user.
SpaceID Used in the request URL (see above) Unique ID of the space.

Example URL to DELETE: https://myintranet.communifire.com/api/users/26/spaces/11/roles

Response JSON sample where indicator (true/false) is returned as ResponseData


{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":true
}


Please Note Your content type that you pass in the header of your request should be 'application/json'.

Wiki Index

Pages

Intranet Software