Loading ...

REST API: Assign User Role | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: User Roles » REST API: Assign User Role
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 24

REST API: Assign User Role

0 
 /5
0 (0votes)

Please Note 

  • This method only add user roles at the Top Level Community if the Role is applied Manually. If assignment is automated through Personas, any Persona actions will overrule manual assignment.
  • To add a user's Space Role via the REST API, see REST API: Assign Space Role 

Assign User Role

POST /api/users/{UserID}/roles

Assign top level roles to a user. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
POST
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 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 as a path parameter Unique identifier for a particular user.
RoleID Used in the request body Unique identifier for a particular role.

Example Request

POST https://myintranet.communifire.com/api/users/1323/roles

Body:

"67"

Example Response

True/false is returned as ResponseData.

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

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

Wiki Index

Pages

Intranet Software