Loading ...

REST API: Check Permissions | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Permissions » REST API: Check Permissions
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 19

REST API: Check Permissions

0 
 /5
0 (0votes)

Check permissions

GET /api/permissions/access

Get permissions JSON object from database. List of supported entities: Articles, Blogs, CMS Pages, Wikis, Files, Videos, Ideas, Photos, Events, Forums, Cases. Valid for Communifire 6.0 and above.

Method Details

HTTP Method
GET
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.
EntityType Used in the request URL (see below). For what REST API: System Entity Types  you want to fetch permissions.
PermissionsCsv Used in the request URL (see below). CSV of the REST API: Permission Types that you want to check for the current user.
For example: CREATE, UPDATE, DELETE
Here, you will get a response if the current user has CREATE, UPDATE, DELETE permissions for given entity type.
Optional Parameters How to use Description
EntityID &entityid=x - Used in the request URL Entity ID needs to be specified only where permissions are entity based.
Entity types where permissions are entity based:
  • Files
  • Forums
  • Forum Groups
  • Tasks
You will get default permissions for these entity types if you don't specify entity ID for above entity types.
SpaceID &spaceid=x - Used in the request URL Specify space ID if permissions need to be fetched for a space.
UserID &userid=x - Used in the request URL Specify User ID when you want to fetch permissions of the specified user. (Only Site Administrators are allowed, and Space Administrators are also allowed when SpaceID > 0)
RoleID &roleid=x - Used in the request URL Specify Role ID when you want to fetch permissions for the specified Role. (Only Site Administrators are allowed, and Space Administrators are also allowed when SpaceID > 0)

Example URL to GET: https://your-community.com/api/permissions/access?entitytype=3&permissionsCsv=create,update,delete

Response JSON sample where permissions JSON object is returned as ResponseData

Here is an example of JSON data returned from the API call.

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": {
    "create": true,
    "update": true,
    "delete": false
  }
}

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

 

Wiki Index

Pages

Intranet Software