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 SitePermission (object)

List of the site permissions

siteIdinteger (int32)

Site ID

rdsHostsSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

rdsHostPoolsSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

remotePCsSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

gatewaysSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

brokersSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

halbSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

themesSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

publishingSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

connectionSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

certificateSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

winDevicesSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

customRoutesSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

appPackagesSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

manageSessionsByADGroupsSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

globalPermissionsGlobalPermissions (object)

The global permissions

monitoringGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

reportingGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

licenseGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

Request

Response

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

siteIdinteger (int32)

Site ID for the permission being set (optional)

Body

Custom Permission settings

objIdnullable integer (int32)

ID of a particular RAS Farm object to assign permissions for.

objectType*PermissionObjectType (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*PermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

Response

No Content

Request

Response

Update

PUT/api/AdminAccount/{adminId}/CustomPermission

Path parameters

adminId*integer (int32)

Admin Account ID

Query parameters

siteIdinteger (int32)

Site ID for the permission being set (optional)

Body

Custom Permission settings

objIdnullable integer (int32)

ID of a particular RAS Farm object to assign permissions for.

objectType*PermissionObjectType (enum)

Permission Object Types

permissions*PermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

Response

No Content

Request

Response

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 SitePermission (object)

List of the site permissions

siteIdinteger (int32)

Site ID

rdsHostsSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

rdsHostPoolsSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

remotePCsSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

gatewaysSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

brokersSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

halbSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

themesSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

publishingSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

connectionSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

certificateSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

winDevicesSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

customRoutesSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

appPackagesSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

manageSessionsByADGroupsSiteTypePermission (object)

Site type permission

sitePermissionGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objectPermissionsnullable array of ObjectPermission (object)

List of object permissions for this site

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

objIdinteger (int32)

globalPermissionsGlobalPermissions (object)

The global permissions

monitoringGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

reportingGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

licenseGlobalPermission (object)

The global permission

permissionsPermissionFlags (enum)

Permission Flags

0 = None,1 = View,2 = Modify,4 = ManageSessions,8 = Add,16 = Delete,32 = Control

Request

Response

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();

{
  "sitePermissions": [
    {
      "siteId": 0,
      "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": 0
          }
        ]
      },
      "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": 0
          }
        ]
      },
      "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": 0
          }
        ]
      },
      "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": 0
          }
        ]
      },
      "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": 0
          }
        ]
      },
      "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": 0
          }
        ]
      },
      "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": 0
          }
        ]
      },
      "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": 0