Custom Permission
Get
Retrieve the Custom Permissions of an Admin Account by ID.
GET/api/AdminAccount/{adminId}/CustomPermission
Path parameters
adminId*integer (int32)
Admin Account ID
Response
Success
Body
sitePermissionsnullable array of object
List of the site permissions
globalPermissionsobject
The global permissions
Request
const response = await fetch('/api/AdminAccount/{adminId}/CustomPermission', {
method: 'GET',
headers: {},
});
const data = await response.json();Response
{
"sitePermissions": [
{
"siteId": 1,
"rdsHosts": {
"sitePermission": {
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
]
},
"objectPermissions": [
{
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
],
"objId": 1
}
]
},
"rdsHostPools": {
"sitePermission": {
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
]
},
"objectPermissions": [
{
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
],
"objId": 1
}
]
},
"remotePCs": {
"sitePermission": {
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
]
},
"objectPermissions": [
{
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
],
"objId": 1
}
]
},
"gateways": {
"sitePermission": {
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
]
},
"objectPermissions": [
{
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
],
"objId": 1
}
]
},
"brokers": {
"sitePermission": {
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
]
},
"objectPermissions": [
{
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
],
"objId": 1
}
]
},
"halb": {
"sitePermission": {
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
]
},
"objectPermissions": [
{
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
],
"objId": 1
}
]
},
"themes": {
"sitePermission": {
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
]
},
"objectPermissions": [
{
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
],
"objId": 1
}
]
},
"publishing": {
"sitePermission": {
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
]
},
"objectPermissions": [
{
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
],
"objId": 1
}
]
},
"connection": {
"sitePermission": {
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
]
},
"objectPermissions": [
{
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
],
"objId": 1
}
]
},
"certificate": {
"sitePermission": {
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
]
},
"objectPermissions": [
{
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
],
"objId": 1
}
]
},
"winDevices": {
"sitePermission": {
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
]
},
"objectPermissions": [
{
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
],
"objId": 1
}
]
},
"customRoutes": {
"sitePermission": {
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
]
},
"objectPermissions": [
{
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
],
"objId": 1
}
]
},
"appPackages": {
"sitePermission": {
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
]
},
"objectPermissions": [
{
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
],
"objId": 1
}
]
},
"manageSessionsByADGroups": {
"sitePermission": {
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
]
},
"objectPermissions": [
{
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
],
"objId": 1
}
]
}
}
],
"globalPermissions": {
"monitoring": {
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
]
},
"reporting": {
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
]
},
"license": {
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
]
}
}
}Update
Update a Custom Permission of an Admin Account. Specifying a SiteId is mandatory except for Monitoring and Reporting. To set a Permission for a specific object, provide an ObjId within the body. To set a Global Permission, do not provide an ObjId within the body.
PUT/api/AdminAccount/{adminId}/CustomPermission
Path parameters
adminId*integer (int32)
Admin Account ID
Query parameters
Body
Custom Permission settings
objIdnullable integer (int32)
ID of a particular RAS Farm object to assign permissions for.
objectType*enum
Permission Object Types
3 = Gateways,5 = RemotePCs,7 = Brokers,16 = RDSHostPools,26 = WinDevices,31 = Themes,40 = Publishing,44 = Certificate,51 = HALB,83 = CustomRoutes,90 = AppPackages,2003 = Reporting,2004 = Monitoring,2012 = Connection,2023 = AVD,2032 = License,2033 = ManageSessionsByADGroups
permissions*enum
Permission Flags
0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control
Response
No Content
Request
const response = await fetch('/api/AdminAccount/{adminId}/CustomPermission', {
method: 'PUT',
headers: {
"Content-Type": "application/json; api-version=1.0"
},
body: JSON.stringify({
"objectType": [
"3 = Gateways",
"5 = RemotePCs",
"7 = Brokers",
"16 = RDSHostPools",
"26 = WinDevices",
"31 = Themes",
"40 = Publishing",
"44 = Certificate",
"51 = HALB",
"83 = CustomRoutes",
"90 = AppPackages",
"2003 = Reporting",
"2004 = Monitoring",
"2012 = Connection",
"2023 = AVD",
"2032 = License",
"2033 = ManageSessionsByADGroups"
],
"permissions": [
"0 = None",
"1 = View",
"2 = Modify",
"4 = ManageSessions",
"8 = Add",
"16 = Delete",
"32 = Control"
]
}),
});
const data = await response.json();Response
{
"type": "text",
"title": "text",
"status": 1,
"detail": "text",
"instance": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}Last updated
Was this helpful?