Current Admin Permissions

Get Current Admin Permission

Retrieve the Permissions of the logged Admin.

GET/api/Session/CurrentAdminPermissions

Response

Success

Body

adminNamenullable string

The current admin name

adminTypeAdminType (enum)

Admin Type

0 = User,1 = Group,2 = UserGroup

emailnullable string

Email address of the current admin

groupNamenullable string

The group name

mobilenullable string

Mobile number of the current admin

sidnullable string

The SID of the current admin

permissionsPermissionType (enum)

Administrator type

0 = PowerAdmin,1 = RootAdmin,2 = CustomAdmin

runtimeSitesListnullable array of integer (int32)

List of Runtime Sites for the current admin

itemsinteger (int32)

farmModeFarmMode (enum)

Farm Mode

0 = Standard,1 = TenantBroker

monitoringboolean

Whether monitoring is enabled or not for the current admin

reportingboolean

Whether reporting is enabled or not for the current admin

licensingboolean

Whether licensing is enabled or not for the current admin

quickKeypadboolean

Whether quick keypad is enabled or not for the current admin

policiesboolean

Whether policies are enabled or not for the current admin

sectionPermissionsSectionPermissions (object)

Section Permissions

sectionPermissionsListnullable array of SectionPermission (object)

List of sections for which permissions to manage are granted.

siteIdinteger (int32)

Site ID

tenantsboolean

Permission to manage Tenants

rdpServersboolean

Permission to manage Remote Desktop Servers

rdpGroupsboolean

Permission to manage Remote Desktop Groups

rdpSchedulerboolean

Permission to manage Remote Desktop Scheduler

rdpSessionMgmntboolean

Permission to manage Remote Desktop Sessions

providersboolean

Permission to manage Providers

vdiHostPoolsboolean

Permission to manage VDI Host Pools

vdiTemplatesboolean

Permission to manage VDI Templates

vdiHostsboolean

Permission to manage VDI Hosts

vdiSessionMgmntboolean

Permission to manage VDI Sessions

gatewaysboolean

Permission to manage Gateways

tunnellingPoliciesboolean

Permission to manage Tunneling Policies

pCsboolean

Permission to manage PCs

brokersboolean

Permission to manage Connection Brokers

autoPromoteboolean

Permission to Auto Promote

halbboolean

Permission to manage HALB

auditingboolean

Permission to manage Auditing

globalLoggingboolean

Permission to manage Global Logging

redirURLboolean

Permission to manage URL Redirection

notificationsboolean

Permission to manage Notifications

globalClientSettsboolean

Permission to manage Global Client Settings

siteFeaturesboolean

Permission to manage Site Features

themesboolean

Permission to manage Themes

certificatesboolean

Permission to manage Certificates

enrollmentServersboolean

Permission to manage Enrollment Servers

adIntegrationboolean

Permission to manage AD Integration

loadBalancerboolean

Permission to manage Load Balancer

publishingboolean

Permission to manage Publishing

universalPrintingboolean

Permission to manage Universal Printing

universalScanningboolean

Permission to manage Universal Scanning

connectionboolean

Permission to manage Connection

connAuthenticateboolean

Permission to manage Connection Authentication

connSettingsboolean

Permission to manage Connection Settings

connMFAuthenticateboolean

Permission to manage Connection Multi-Factor Authentication

samlboolean

Permission to manage SAML

connAllowedDevicesboolean

Permission to manage Connection Allowed Devices

deviceManagerboolean

Permission to manage Device Manager

devicesboolean

Permission to manage Devices

winDeviceGroupsboolean

Permission to manage Windows Device Groups

devicesOptionsboolean

Permission to manage Devices Options

devicesScheduleboolean

Permission to manage Devices Schedule

administrationboolean

Permission to manage Administration

farmFeaturesboolean

Permission to manage Farm Features

powerPermissionRASPowerPermission (object)

The RAS power administrator permissions

adminIdinteger (int32)

Admin account ID

allowSiteChangesboolean

Permission to do changes to RAS Site settings.

allowConnectionChangesboolean

Permission to do changes to Connection settings.

allowSessionManagementboolean

Permission to manage user sessions.

allowDeviceManagementChangesboolean

Permission to manage client devices.

allowViewingReportingInfoboolean

Permission for read mode access to RAS Reporting.

allowViewingLicenseInfoboolean

Permission for read mode access to the License Information.

allowViewingSiteInfoboolean

Permission for read mode access to RAS Site information.

allowPublishingChangesboolean

Permission to manage published resources.

allowPolicyChangesboolean

Permission to manage RAS client Policies.

allowViewingPolicyInfoboolean

Permission for read mode to RAS client Policies.

allowAllSitesboolean

Permission to manage all Sites in the Farm.

allowInSiteIdsnullable array of integer (int32)

A list of site IDs which the administrator should be allowed to manage.

itemsinteger (int32)

customPermissionCustomPermission (object)

The custom permissions list

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

Logon

Log on

Authenticate the user. When successful, an authorization token will be generated.

POST/api/Session/logon

Query parameters

localAuthboolean

Authenticate with local machine to configure local Web Admin Settings. NOTE: Only localhost connections are allowed.

Body

Contains the information about the session.

username*nullable string

Parallels RAS administrator username.

password*nullable string

Parallels RAS administrator password.

Response

Success

Body

authTokennullable string

The Authentication Token of the current session.

localAuthboolean

Specifies if the user is Locally Authenticated or with RAS Connection Broker.

userIdinteger (int32)

The User ID connected to the current session.

applySettingsEnabledboolean

Specifies if Settings need to be applied or not.

connectedSiteIdinteger (int32)

The Site ID to which the current session is connected to.

settingsIdinteger (int32)

The current Settings ID.

sessionIdinteger (int32)

The ID of the current session.

connectedServernullable string

The Server that the current session is connected to.

licensingServernullable string

The Licensing Server.

primaryBrokerConnectionboolean

Specifies if the session is connected with the Primary Connection Broker of a Site.

licensingServerConnectionboolean

Specifies if the session is connected is with the Licensing Server.

domainnullable string

Specifies the Domain where the Connection Broker is installed.

farmNamenullable string

Specifies the Farm Name.

farmGUIDnullable string

Specifies the Farm GUID.

Request

Response

Get Current Admin Permission

Retrieve the Permissions of the logged Admin.

GET/api/Session/CurrentAdminPermissions

Response

Success

Body

adminNamenullable string

The current admin name

adminTypeAdminType (enum)

Admin Type

0 = User,1 = Group,2 = UserGroup

emailnullable string

Email address of the current admin

groupNamenullable string

The group name

mobilenullable string

Mobile number of the current admin

sidnullable string

The SID of the current admin

permissionsPermissionType (enum)

Administrator type

0 = PowerAdmin,1 = RootAdmin,2 = CustomAdmin

runtimeSitesListnullable array of integer (int32)

List of Runtime Sites for the current admin

itemsinteger (int32)

farmModeFarmMode (enum)

Farm Mode

0 = Standard,1 = TenantBroker

monitoringboolean

Whether monitoring is enabled or not for the current admin

reportingboolean

Whether reporting is enabled or not for the current admin

licensingboolean

Whether licensing is enabled or not for the current admin

quickKeypadboolean

Whether quick keypad is enabled or not for the current admin

policiesboolean

Whether policies are enabled or not for the current admin

sectionPermissionsSectionPermissions (object)

Section Permissions

sectionPermissionsListnullable array of SectionPermission (object)

List of sections for which permissions to manage are granted.

siteIdinteger (int32)

Site ID

tenantsboolean

Permission to manage Tenants

rdpServersboolean

Permission to manage Remote Desktop Servers

rdpGroupsboolean

Permission to manage Remote Desktop Groups

rdpSchedulerboolean

Permission to manage Remote Desktop Scheduler

rdpSessionMgmntboolean

Permission to manage Remote Desktop Sessions

providersboolean

Permission to manage Providers

vdiHostPoolsboolean

Permission to manage VDI Host Pools

vdiTemplatesboolean

Permission to manage VDI Templates

vdiHostsboolean

Permission to manage VDI Hosts

vdiSessionMgmntboolean

Permission to manage VDI Sessions

gatewaysboolean

Permission to manage Gateways

tunnellingPoliciesboolean

Permission to manage Tunneling Policies

pCsboolean

Permission to manage PCs

brokersboolean

Permission to manage Connection Brokers

autoPromoteboolean

Permission to Auto Promote

halbboolean

Permission to manage HALB

auditingboolean

Permission to manage Auditing

globalLoggingboolean

Permission to manage Global Logging

redirURLboolean

Permission to manage URL Redirection

notificationsboolean

Permission to manage Notifications

globalClientSettsboolean

Permission to manage Global Client Settings

siteFeaturesboolean

Permission to manage Site Features

themesboolean

Permission to manage Themes

certificatesboolean

Permission to manage Certificates

enrollmentServersboolean

Permission to manage Enrollment Servers

adIntegrationboolean

Permission to manage AD Integration

loadBalancerboolean

Permission to manage Load Balancer

publishingboolean

Permission to manage Publishing

universalPrintingboolean

Permission to manage Universal Printing

universalScanningboolean

Permission to manage Universal Scanning

connectionboolean

Permission to manage Connection

connAuthenticateboolean

Permission to manage Connection Authentication

connSettingsboolean

Permission to manage Connection Settings

connMFAuthenticateboolean

Permission to manage Connection Multi-Factor Authentication

samlboolean

Permission to manage SAML

connAllowedDevicesboolean

Permission to manage Connection Allowed Devices

deviceManagerboolean

Permission to manage Device Manager

devicesboolean

Permission to manage Devices

winDeviceGroupsboolean

Permission to manage Windows Device Groups

devicesOptionsboolean

Permission to manage Devices Options

devicesScheduleboolean

Permission to manage Devices Schedule

administrationboolean

Permission to manage Administration

farmFeaturesboolean

Permission to manage Farm Features

powerPermissionRASPowerPermission (object)

The RAS power administrator permissions

adminIdinteger (int32)

Admin account ID

allowSiteChangesboolean

Permission to do changes to RAS Site settings.

allowConnectionChangesboolean

Permission to do changes to Connection settings.

allowSessionManagementboolean

Permission to manage user sessions.

allowDeviceManagementChangesboolean

Permission to manage client devices.

allowViewingReportingInfoboolean

Permission for read mode access to RAS Reporting.

allowViewingLicenseInfoboolean

Permission for read mode access to the License Information.

allowViewingSiteInfoboolean

Permission for read mode access to RAS Site information.

allowPublishingChangesboolean

Permission to manage published resources.

allowPolicyChangesboolean

Permission to manage RAS client Policies.

allowViewingPolicyInfoboolean

Permission for read mode to RAS client Policies.

allowAllSitesboolean

Permission to manage all Sites in the Farm.

allowInSiteIdsnullable array of integer (int32)

A list of site IDs which the administrator should be allowed to manage.

itemsinteger (int32)

customPermissionCustomPermission (object)

The custom permissions list

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

{
  "adminName": "text",
  "adminType": [
    "0 = User",
    "1 = Group",
    "2 = UserGroup"
  ],
  "email": "text",
  "groupName": "text",
  "mobile": "text",
  "sid": "text",
  "permissions": [
    "0 = PowerAdmin",
    "1 = RootAdmin",
    "2 = CustomAdmin"
  ],
  "runtimeSitesList": [],
  "farmMode": [
    "0 = Standard",
    "1 = TenantBroker"
  ],
  "monitoring": false,
  "reporting": false,
  "licensing": false,
  "quickKeypad": false,
  "policies": false,
  "sectionPermissions": {
    "sectionPermissionsList": [
      {
        "tenants": false,
        "rdpServers": false,
        "rdpGroups": false,
        "rdpScheduler": false,
        "rdpSessionMgmnt": false,
        "providers": false,
        "vdiHostPools": false,
        "vdiTemplates": false,
        "vdiHosts": false,
        "vdiSessionMgmnt": false,
        "gateways": false,
        "tunnellingPolicies": false,
        "pCs": false,
        "brokers": false,
        "autoPromote": false,
        "halb": false,
        "auditing": false,
        "globalLogging": false,
        "redirURL": false,
        "notifications": false,
        "globalClientSetts": false,
        "siteFeatures": false,
        "themes": false,
        "certificates": false,
        "enrollmentServers": false,
        "adIntegration": false,
        "loadBalancer": false,
        "publishing": false,
        "universalPrinting": false,
        "universalScanning": false,
        "connection": false,
        "connAuthenticate": false,
        "connSettings": false,
        "connMFAuthenticate": false,
        "saml": false,
        "connAllowedDevices": false,
        "deviceManager": false,
        "devices": false,
        "winDeviceGroups": false,
        "devicesOptions": false,
        "devicesSchedule": false,
        "administration": false,
        "farmFeatures": false
      }
    ]
  },
  "powerPermission": {
    "allowSiteChanges": false,
    "allowConnectionChanges": false,
    "allowSessionManagement": false,
    "allowDeviceManagementChanges": false,
    "allowViewingReportingInfo": false,
    "allowViewingLicenseInfo": false,
    "allowViewingSiteInfo": false,
    "allowPublishingChanges": false,
    "allowPolicyChanges": false,
    "allowViewingPolicyInfo": false,
    "allowAllSites": false,
    "allowInSiteIds": []
  },
  "customPermission": {
    "sitePermissions": [
      {
        "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"
              ]
            }
          ]
        },
        "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"
              ]
            }
          ]
        },
        "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"
              ]
            }
          ]
        },
        "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"
              ]
            }
          ]
        },
        "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"
              ]
            }
          ]
        },
        "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"
              ]
            }
          ]
        },
        "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"
              ]
            }
          ]
        },
        "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"
              ]
            }
          ]
        },
        "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"
              ]
            }
          ]
        },
        "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"
              ]
            }
          ]
        },
        "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"
              ]
            }
          ]
        },
        "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"
              ]
            }
          ]
        },
        "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"
              ]
            }
          ]
        },
        "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"
              ]
            }
          ]
        }
      }
    ],
    "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"
        ]
      }
    }
  }
}

Log on

Authenticate the user. When successful, an authorization token will be generated.

POST/api/Session/logon

Query parameters

localAuthboolean

Authenticate with local machine to configure local Web Admin Settings. NOTE: Only localhost connections are allowed.

Body

Contains the information about the session.

username*nullable string

Parallels RAS administrator username.

password*nullable string

Parallels RAS administrator password.

Response

Success

Body

authTokennullable string

The Authentication Token of the current session.

localAuthboolean

Specifies if the user is Locally Authenticated or with RAS Connection Broker.

userIdinteger (int32)

The User ID connected to the current session.

applySettingsEnabledboolean

Specifies if Settings need to be applied or not.

connectedSiteIdinteger (int32)

The Site ID to which the current session is connected to.

settingsIdinteger (int32)

The current Settings ID.

sessionIdinteger (int32)

The ID of the current session.

connectedServernullable string

The Server that the current session is connected to.

licensingServernullable string

The Licensing Server.

primaryBrokerConnectionboolean

Specifies if the session is connected with the Primary Connection Broker of a Site.

licensingServerConnectionboolean

Specifies if the session is connected is with the Licensing Server.

domainnullable string

Specifies the Domain where the Connection Broker is installed.

farmNamenullable string

Specifies the Farm Name.

farmGUIDnullable string

Specifies the Farm GUID.

Request

Response

Administrator Sessions

Current Admin Permissions

Logoff

Logon

Current Admin Permissions

Get Current Admin Permission

Logoff

Log off

LogOff Other Admin

Administrator Sessions

List

Logon

Log on

Log off

LogOff Other Admin

List

Get Current Admin Permission

Log on