Enumerating user roles

You can get the list of user roles available to your own company and your customers using the EnumerateUserRoles method.

Required parameters

ParameterDescriptionSupported values
partnerIdThe ID of the customer the users are created for (retrieved through the GetPartnerInfo method)<int> Integer

Sample request

{
    "jsonrpc":"2.0",
    "visa": "{{visa}}",
    "id":"jsonrpc",
    "method" : "EnumerateUserRoles",
    "params" : {
	    "partnerId" : 123456
    }
}

Sample response

{
    "id": "jsonrpc",
    "jsonrpc": "2.0",
    "result": {
	"result": [
	    {
		"Id": 1,
		"Name": "SuperUser"
	    },
	    {
		"Id": 2,
		"Name": "Administrator"
	    },
	    {
		"Id": 3,
		"Name": "Manager"
	    },
	    {
		"Id": 4,
		"Name": "Operator"
	    },
	    {
		"Id": 5,
		"Name": "Supporter"
	    },
	    {
		"Id": 6,
		"Name": "Reporter"
	    },
	    {
		"Id": 7,
		"Name": "Notifier"
	    }
	]
    },
    "visa": "{{visa}}"
}

Did this page help you?