Show Role REST Endpoint

Ben Tiedt — Tue, 19 Nov 2019 20:19:04 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:19:04

URLs

GET api.ashx/v2/{application}/{id}/roles/{roleid}.xml (or .json)

SHOW details for a role for an application.

GET api.ashx/v2/{application}/{id}/roles/{roleid}/permissions.xml (or .json)

SHOW details for a role with permissions for an application.

GET api.ashx/v2/roles/{roleid}.xml (or .json)

SHOW details for a role.

GET api.ashx/v2/roles/{roleid}/permissions.xml (or .json)

SHOW permissions for role.

Request Parameters

Name	Type	Description	Required
Application	`string`	Application	Required
Id	`int?`	Id	Required
RoleId	`int?`	Role Id	Required
IncludePermissions	`bool`	Include Permissions	Optional
Include	`string`	Options for include are granted or denied. Ex: include=granted	Optional

Example Requests

C# REST SDK

This example uses the REST SDK to access the Community REST API within a .Net C# application. In the example, USER_NAME is the user name of the effective user for the request and OAUTH_CLIENT_ID and OAUTH_SECRET are the OAuth client ID and secret, respectively, associated to this application as configured in Administration > Integration > OAuth Clients with the "Client Credentials" grant type enabled. See the documentation for the REST SDK for more details about installation, configuration, and usage options.

var host = new ClientCredentialsRestHost("USER_NAME", "https://mysite.com/", "OAUTH_CLIENT_ID", "OAUTH_SECRET");
var response = host.GetToDynamic(2, "{application}/{id}/roles/{roleid}.json", false, new RestGetOptions {
	PathParameters = new System.Collections.Specialized.NameValueCollection {
		{ "application", "application" },
		{ "id", "6" },
		{ "roleid", "6" }
	}
});

Widget Javascript

This example uses the [[rest JavaScript API Module|rest JavaScript API]] to access the Community REST API within the Community web UI. When accessing the REST API through the javascript API, the effective user is the current contextual user of the web interface.

jQuery.telligent.evolution.get({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/{application}/{id}/roles/{roleid}.json',
	data: { 
		'application': 'application',
		'id': '6',
		'roleid': '6'
	},
	success: function(response) {

	}
});

cURL

This example uses the cURL command-line HTTP utility. ENCODED_TOKEN in the example is the base64-encoded concatenation of the user's API key (created from the user's profile), a colon (:), and the user's user name. Learn more about using the REST API.

curl -H "Rest-User-Token: ENCODED_TOKEN" -X GET https://mysite.com/api.ashx/v2/application/6/roles/6.xml

Example Responses

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Info>
    <Message>string</Message>
    <Message>string</Message>
  </Info>
  <Warnings>
    <Message>string</Message>
    <Message>string</Message>
  </Warnings>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
  <Role>
    <Id>6</Id>
    <Name>name</Name>
    <Description>description</Description>
    <GroupId>25</GroupId>
    <IsSystemRole>true</IsSystemRole>
    <AvatarUrl>avatarurl</AvatarUrl>
    <PermissionEntries>
      <PermissionEntry>
        <Id>49fec544-6df7-4a82-872b-f8be586d5e9e</Id>
        <PermissionId>permissionid</PermissionId>
        <Name>name</Name>
        <IsAllowed>true</IsAllowed>
        <IsImmediate>true</IsImmediate>
      </PermissionEntry>
      <PermissionEntry>
        <Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id>
        <PermissionId>permissionid</PermissionId>
        <Name>name</Name>
        <IsAllowed>true</IsAllowed>
        <IsImmediate>true</IsImmediate>
      </PermissionEntry>
    </PermissionEntries>
  </Role>
</Response>

JSON

{
  "Role": {
    "Id": 6,
    "Name": "name",
    "Description": "description",
    "GroupId": 25,
    "IsSystemRole": true,
    "ImageUrl": "",
    "AvatarUrl": "avatarurl",
    "PermissionEntries": [
      {
        "Id": "49fec544-6df7-4a82-872b-f8be586d5e9e",
        "PermissionId": "permissionid",
        "Name": "name",
        "IsAllowed": true,
        "IsImmediate": true
      },
      {
        "Id": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46",
        "PermissionId": "permissionid",
        "Name": "name",
        "IsAllowed": true,
        "IsImmediate": true
      }
    ]
  },
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}