Custom Permission
Was this helpful?
Was this helpful?
Retrieve the Custom Permissions of an Admin Account by ID.
Admin Account ID
curl -L \
--url '/api/AdminAccount/{adminId}/CustomPermission'{
"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"
]
}
}
}Success
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.
Admin Account ID
Site ID for the permission being set (optional)
Update custom administrator permissions
ID of a particular RAS Farm object to assign permissions for.
Permission Object Types
Permission Flags
curl -L \
--request PUT \
--url '/api/AdminAccount/{adminId}/CustomPermission' \
--header 'Content-Type: application/json; api-version=1.0' \
--data '{
"objId": 1,
"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"
]
}'No Content
No Content