Loading ...

REST API: Add Role | Communifire Documentation

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

REST API: Add Role

0 
 /5
0 (0votes)

Please Note This method creates roles at the Top Level Community. See REST API: Add Space Role for how to create a new space role via the REST API.

Add Role

POST /api/roles

Add a new top level role. 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.
Role JSON Used in the request body This is JSON that represents a role object that you're creating. This should be of the format seen below in the sample given. The required values in this JSON are given below.
Description Used in the request body Description of the role.
RoleName Used in the request body Name of the role.

Example Request

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

Body:

{
    "Description":"A person whose job is to test something, especially a new product.",
    "RoleName": "Tester"
}

Example Response

Role ID is returned as ResponseData.

{
    "IsError":false,
    "ResponseMessage":"True",
    "ResponseData":61
}

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

 

Wiki Index

Pages

Intranet Software