Get role

This endpoint is used to retrieve the details of a role.

Leave Feedback

URL

<verb> https://{api-url}/api/v2/tenants/{tenantId}/roles/{roleId}

Sample URLs

https://{api-url}/api/v2/tenants/client_8/roles/ROLE-0074b24b-5c0b-2332-dd99-fea506f6cebd
https://{api-url}/api/v2/tenants/msp_6/roles/ROLE-2374b24b-5c0b-2332-dd99-fea506f6ceb1

This API returns role information for devices, device groups, credentials, users, and user groups.

Status code

200 OK

Sample response

{
	"uniqueId": "ROLE-0074b24b-5c0b-2332-dd99-fea506f6cebd",
	"name": "Primary Admin",
	"description": "Parnter Primary Admin",
	"clients": [{
			"uniqueId": "client_9",
			"name": "LeoArt Corp.",
			"activated": true
		},
		{
			"uniqueId": "client_8",
			"name": "LeoArt Lab",
			"activated": true
		}
	],
	"users": [{
			"id": "USR0000000011",
			"loginName": "LeoArtInc@opsramp.com",
			"lastName": "Inc Admin",
			"firstName": "LeoArt",
			"email": "john.smith@gamil.com",
			"phoneNumber": "8096250653"
		},
		{
			"id": "USR0000000013",
			"loginName": "LeoArtPAdmin@opsramp.com",
			"lastName": "Inc PAdmin",
			"firstName": "LeoArt",
			"email": "john.smith@gamil.com",
			"phoneNumber": "8096250653"
		}
	],
	"userGroups": [{
			"id": 5,
			"name": "LeoArt Inc Users",
			"description": "LeoArt Partner Users",
			"uniqueId": "USRGRP-5dd6cb59-b4cf-083a-29f6-7f6fc2688fd3"
		},
		{
			"id": 6,
			"name": "LeoArt Inc Escalation Users",
			"description": "LeoArt Inc Escalation Users",
			"uniqueId": "USRGRP-98c1733f-0429-001d-8196-54a85e15d49d"
		}
	],
	"devices": [{
			"id": "2912ca9f-5c62-451f-82a8-8c08ca9c9447",
			"generalInfo": {
				"ipAddresses": "172.28.2.233",
				"hostName": "HYDLPT159",
                                "resourceType": "Desktop",
                                "resourceName": "172.28.2.233",
                                "aliasName": "res 1"
			},
			"clientUniqueId": "client_8",
			"type": "DEVICE"
		},
		{
			"id": "d628b4f1-37ad-49de-8487-43125ec3178a",
			"generalInfo": {
				"ipAddresses": "172.28.16.15",
				"hostName": "HYDLPT204",
                                "resourceType": "Desktop",
                                "resourceName": "172.28.16.15",
                                "aliasName": "res 2"
			}
	],
	"deviceGroups": [{
			"id": "DGP-3bc09935-6510-4205-bb6f-6d2b9561fc43",
			"name": "Dev-Group",
			"description": "Device group",
			"createdDate": "2016-10-20T07:45:06+0000",
			"updatedDate": "2016-10-20T07:45:06+0000"
		},
		{
			"id": "DGP-876f73a7-c0e4-409c-a757-5c64205ff97a",
			"name": "HYD-WINDOWS",
			"description": "Windows Systems at HYD",
			"createdDate": "2016-07-24T07:27:44+0000",
			"updatedDate": "2016-07-24T07:33:15+0000"
		},
		{
			"id": "DGP-fbbabccc-578b-4658-9475-178ab034c20b",
			"name": "Testing-dev-group",
			"description": "testing device group",
			"createdDate": "2016-10-20T07:43:48+0000",
			"updatedDate": "2016-10-20T07:43:49+0000"
		}
	],
	"credentialSets": [{
			"uniqueId": "mmtKsSTyXYqtEtrRMRSmWjAh",
			"name": "Agent-WMI-Discovery",
			"secure": false,
			"port": 0,
			"snmpVersion": "V2",
			"description": "Discovery credentials",
			"autoEnableMode": false,
			"universal": true,
			"spSecure": false,
			"spPort": 0,
			"timeoutMs": 10000
		},
		{
			"uniqueId": "EAmBeuHhCY5hrCvHVejrccJj",
			"name": "AWS AWS Integration",
			"secure": false,
			"port": 0,
			"snmpVersion": "V2",
			"autoEnableMode": false,
			"universal": true,
			"spSecure": false,
			"spPort": 0,
			"timeoutMs": 0
		}
	],
	"permissions": [{
			"id": 13,
			"name": "Dispatcher",
			"description": "Dispatcher"
		},
		{
			"id": 7,
			"name": "Auditor Manage",
			"description": "Auditor Manage"
		},
		{
			"id": 8,
			"name": "Auditor View",
			"description": "Auditor View"
		}
	]
}