Get all available platform roles

You can use a GET request to retrieve a list of all of the roles on a platform. You'll need MANAGE_ALL_ROLES or VIEW_ALL_ROLES permissions to perform this operation.

Request

Sample request

The request below returns all available platform roles:

curl GET https://api.cxengage.net/v1/roles

Response

Sample response

The request returns JSON structured like the example below:

{
     {
	"result": [
	{
	  "description": "platform administrator",
	  "permissions": [
	                 "50e3ca30-422f-11e5-a4ce-159fa7fbaa01",
			 "50d6aad0-422f-11e5-a4ce-159fa7fbaa01",
			 "50cce6d0-422f-11e5-a4ce-159fa7fbaa01",
			 "50dd1370-422f-11e5-a4ce-159fa7fbaa01",
			 "50d34f70-422f-11e5-a4ce-159fa7fbaa01",
			 "50e5ed10-422f-11e5-a4ce-159fa7fbaa01",
			 "50e1ce60-422f-11e5-a4ce-159fa7fbaa01",
			 "50d9df20-422f-11e5-a4ce-159fa7fbaa01",
			 "50dfab80-422f-11e5-a4ce-159fa7fbaa01"
			],
	  "updated": "2015-08-14T02:51:10Z",
	  "name": "Platform Administrator",
	  "created": "2015-08-14T02:51:10Z",
	  "updatedBy": "00000000-0000-0000-0000-000000000000",
	  "createdBy": "00000000-0000-0000-0000-000000000000",
	  "id": "5145c050-422f-11e5-a4ce-159fa7fbaa01"
	},
   {
	  "description": "platform user",
	  "permissions": [
			  "50e3ca30-422f-11e5-a4ce-159fa7fbaa01",
			  "50e5ed10-422f-11e5-a4ce-159fa7fbaa01"
			  ],
	   "updated": "2015-08-14T02:51:10Z",
	   "name": "Platform User",
	   "created": "2015-08-14T02:51:10Z",
	   "updatedBy": "00000000-0000-0000-0000-000000000000",
	   "createdBy": "00000000-0000-0000-0000-000000000000",
	   "id": "514f5d40-422f-11e5-a4ce-159fa7fbaa01"
    }
  ]
}

Response parameters

The response includes the following parameters:

Parameter Type Description
id UUID The tenant’s unique identifier
permissions UUID A list of permissions associated with the role.
description string A brief description of the role.
name string The name of the role.
type string The type of role — in this case, platform.
updated string The date and time, in UTC format, when the role was last updated.
updatedBy UUID The unique identifier of the user who updated the role.
created string The date and time, in UTC format, when the role was created.
createdBy UUID The unique identifier of the user who created the role.