Loading ...

REST API: Get User's Roles | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Users » REST API: User Roles » REST API: Get User's Roles
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 18

REST API: Get User's Roles

0 
 /5
0 (0votes)

Please Note This method gets user roles at the Top Level Community. See  REST API: Get User's Space Roles  for how to get a user's space roles via the REST API.

Get User's Roles

GET /api/users/{UserID}/roles

Get a user's top level roles. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
GET
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.

Example Request

GET https://myintranet.communifire.com/api/users/1322/roles

Example Response

Role JSON object is returned as ResponseData.

{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":[
        {
            "RoleID":3,
            "UserID": 1322,
            "SpaceID":0,
            "RoleName":"Member",
            "Description":"Registered members of the website",
            "RoleImageFileName":null
        },
        {
            "RoleID":6,
            "UserID":1322,
            "SpaceID":0,
            "RoleName":"Quality Analyst",
            "Description":"Software quality analyst",
            "RoleImageFileName":null
        }
    ]
}

 

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

 

Wiki Index

Pages

Intranet Software