Custom Permission

Get

get

Retrieve the Custom Permissions of an Admin Account by ID.

Path parameters

adminIdinteger · int32Required

Admin Account ID

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/AdminAccount/{adminId}/CustomPermission

HTTPcURLJavaScriptPython

GET /api/AdminAccount/{adminId}/CustomPermission HTTP/1.1
Host: 
Accept: */*

{
  "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"
      ]
    },
    "costInsights": {
      "permissions": [
        "0 = None",
        "1 = View",
        "2 = Modify",
        "4 = ManageSessions",
        "8 = Add",
        "16 = Delete",
        "32 = Control"
      ]
    }
  }
}

Update

put

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.

Path parameters

adminIdinteger · int32Required

Admin Account ID

Query parameters

siteIdinteger · int32Optional

Site ID for the permission being set (optional)

Body

application/json; api-version=1.0

Update custom administrator permissions

objIdinteger · int32 | nullableOptional

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

objectTypestring · enumRequired

Permission Object Types

Possible values:

permissionsstring[Flag] · enumRequired

Permission Flags

Possible values:

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/AdminAccount/{adminId}/CustomPermission

HTTPcURLJavaScriptPython

PUT /api/AdminAccount/{adminId}/CustomPermission HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 473

{
  "objId": 1,
  "objectType": [
    "3 = SecureGateways",
    "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",
    "2034 = CostInsights"
  ],
  "permissions": [
    "0 = None",
    "1 = View",
    "2 = Modify",
    "4 = ManageSessions",
    "8 = Add",
    "16 = Delete",
    "32 = Control"
  ]
}

No content