Administrators

PreviousLogon NextCustom Permission

Last updated 12 months ago

Was this helpful?

List

get

Retrieve Admin Account(s).

Query parameters

Namestring

Admin Account Name (optional)

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/AdminAccount'

200

401

404

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-03-19T16:28:33.907Z",
    "timeLastMod": "2025-03-19T16:28:33.907Z",
    "name": "text",
    "type": [
      "0 = User",
      "1 = Group",
      "2 = UserGroup"
    ],
    "notify": [
      "0 = None",
      "1 = Email"
    ],
    "enabled": true,
    "email": "text",
    "mobile": "text",
    "groupName": "text",
    "fullPermissions": true,
    "permissions": [
      "0 = PowerAdmin",
      "1 = RootAdmin",
      "2 = CustomAdmin"
    ]
  }
]

Success

Create

post

Create a new Admin Account.

Body

namestring | nullablerequired

<para type="description">The name of a user or group to add to the farm as an administrator.</para>

emailstring | nullable

<para type="description">The user email address.</para>

mobilestring | nullable

<para type="description">The user mobile phone number.</para>

enabledboolean

<para type="description">Enables or disables this administrator in the farm.</para>

notifystring · enum

<para type="synopsis">Admin Notify</para> <para type="description"></para> <para type="description"></para>

Options: 0 = None,1 = Email

fullPermissionsbooleanDeprecated

<para type="description">Enable or disable the "Full Permissions" option.</para>

permissionsstring · enum

<para type="synopsis">Administrator type</para> <para type="description"></para> <para type="description"></para>

Options: 0 = PowerAdmin,1 = RootAdmin,2 = CustomAdmin

allowSiteChangesbooleanDeprecated

<para type="description">Deprecated: use 'Set-RASPowerPermission' to set power admin permissions.</para> <para type="description">Enable or disable the "Allow Site changes" option.</para>

allowPublishingChangesbooleanDeprecated

<para type="description">Deprecated: use 'Set-RASPowerPermission' to set power admin permissions.</para> <para type="description">Enable or disable the "Allow Publishing changes" option.</para>

allowConnectionChangesbooleanDeprecated

<para type="description">Deprecated: use 'Set-RASPowerPermission' to set power admin permissions.</para> <para type="description">Enable or disable the "Allow Connection changes" option.</para>

allowViewingReportingInfobooleanDeprecated

<para type="description">Deprecated: use 'Set-RASPowerPermission' to set power admin permissions.</para> <para type="description">Enable or disable the "Allow viewing of RAS Reporting" option.</para>

allowViewingSiteInfobooleanDeprecated

<para type="description">Deprecated: use 'Set-RASPowerPermission' to set power admin permissions.</para> <para type="description">Enable or disable the "Allow viewing of Site Information" option.</para>

allowViewingPolicyInfobooleanDeprecated

allowSessionManagementbooleanDeprecated

<para type="description">Deprecated: use 'Set-RASPowerPermission' to set power admin permissions.</para> <para type="description">Enable or disable the "Allow Session Management" option.</para>

allowDeviceManagementChangesbooleanDeprecated

<para type="description">Deprecated: use 'Set-RASPowerPermission' to set power admin permissions.</para> <para type="description">Enable or disable the "Allow Device Management changes" option.</para>

allowPolicyChangesbooleanDeprecated

<para type="description">Deprecated: use 'Set-RASPowerPermission' to set power admin permissions.</para> <para type="description">Enable or disable the "Allow Policy changes" option.</para>

allowAllSitesbooleanDeprecated

<para type="description">Deprecated: use 'Set-RASPowerPermission' to set power admin permissions.</para> <para type="description">Enable or disable the "All Sites" option. If enabled, the administrator can manage all sites in the farm.</para>

allowInSitesobject[] | nullableDeprecated

<para type="description">Deprecated: use 'Set-RASPowerPermission' to set power admin permissions.</para> <para type="description">Specifies the list of site names (string array) which this administrator should be allowed to manage.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/AdminAccount' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "email": "text",
    "mobile": "text",
    "enabled": true,
    "notify": [
      "0 = None",
      "1 = Email"
    ],
    "fullPermissions": true,
    "permissions": [
      "0 = PowerAdmin",
      "1 = RootAdmin",
      "2 = CustomAdmin"
    ],
    "allowSiteChanges": true,
    "allowPublishingChanges": true,
    "allowConnectionChanges": true,
    "allowViewingReportingInfo": true,
    "allowViewingSiteInfo": true,
    "allowViewingPolicyInfo": true,
    "allowSessionManagement": true,
    "allowDeviceManagementChanges": true,
    "allowPolicyChanges": true,
    "allowAllSites": true,
    "allowInSites": [
      {
        "id": 1,
        "adminCreate": "text",
        "adminLastMod": "text",
        "timeCreate": "2025-03-19T16:28:33.907Z",
        "timeLastMod": "2025-03-19T16:28:33.907Z",
        "name": "text",
        "licensingSite": true,
        "enableHttpHostAttackProtection": true
      }
    ]
  }'

201

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-03-19T16:28:33.907Z",
  "timeLastMod": "2025-03-19T16:28:33.907Z",
  "name": "text",
  "type": [
    "0 = User",
    "1 = Group",
    "2 = UserGroup"
  ],
  "notify": [
    "0 = None",
    "1 = Email"
  ],
  "enabled": true,
  "email": "text",
  "mobile": "text",
  "groupName": "text",
  "fullPermissions": true,
  "permissions": [
    "0 = PowerAdmin",
    "1 = RootAdmin",
    "2 = CustomAdmin"
  ]
}

Created

Get

get

Retrieve an Admin Account by ID.

Path parameters

idinteger · int32required

Admin Account ID

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/AdminAccount/{id}'

200

401

404

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-03-19T16:28:33.907Z",
  "timeLastMod": "2025-03-19T16:28:33.907Z",
  "name": "text",
  "type": [
    "0 = User",
    "1 = Group",
    "2 = UserGroup"
  ],
  "notify": [
    "0 = None",
    "1 = Email"
  ],
  "enabled": true,
  "email": "text",
  "mobile": "text",
  "groupName": "text",
  "fullPermissions": true,
  "permissions": [
    "0 = PowerAdmin",
    "1 = RootAdmin",
    "2 = CustomAdmin"
  ]
}

Success

Update

put

Update Admin Account settings.

Path parameters

idinteger · int32required

Admin Account ID

Body

emailstring | nullable

<para type="description">Parallels RAS administrator email address.</para>

mobilestring | nullable

<para type="description">Parallels RAS administrator mobile phone number.</para>

enabledboolean | nullable

<para type="description">Enable or disable the specified administrator account.</para>

notifystring · enum

<para type="synopsis">Admin Notify</para> <para type="description"></para> <para type="description"></para>

Options: 0 = None,1 = Email

permissionsstring · enum

<para type="synopsis">Administrator type</para> <para type="description"></para> <para type="description"></para>

Options: 0 = PowerAdmin,1 = RootAdmin,2 = CustomAdmin

fullPermissionsboolean | nullableDeprecated

<para type="description">Whether to grant the specified administrator full permissions in the farm. If set to False, permissions can be set individually.</para>

allowSiteChangesboolean | nullableDeprecated

<para type="description">Deprecated: use 'Set-RASPowerPermission' to set power admin permissions.</para> <para type="description">Enable or disable the "Allow Site changes" option.</para>

allowPublishingChangesboolean | nullableDeprecated

<para type="description">Deprecated: use 'Set-RASPowerPermission' to set power admin permissions.</para> <para type="description">Enable or disable the "Allow Publishing changes" option.</para>

allowConnectionChangesboolean | nullableDeprecated

<para type="description">Deprecated: use 'Set-RASPowerPermission' to set power admin permissions.</para> <para type="description">Enable or disable the "Allow Connection changes" option.</para>

allowViewingReportingInfoboolean | nullableDeprecated

<para type="description">Deprecated: use 'Set-RASPowerPermission' to set power admin permissions.</para> <para type="description">Enable or disable the "Allow viewing of RAS Reporting" option.</para>

allowViewingSiteInfoboolean | nullableDeprecated

allowViewingPolicyInfoboolean | nullableDeprecated

allowSessionManagementboolean | nullableDeprecated

<para type="description">Deprecated: use 'Set-RASPowerPermission' to set power admin permissions.</para> <para type="description">Enable or disable the "Allow Session Management" option.</para>

allowDeviceManagementChangesboolean | nullableDeprecated

allowPolicyChangesboolean | nullableDeprecated

<para type="description">Deprecated: use 'Set-RASPowerPermission' to set power admin permissions.</para> <para type="description">Enable or disable the "Allow Policy changes" option.</para>

allowAllSitesboolean | nullableDeprecated

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/AdminAccount/{id}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "email": "text",
    "mobile": "text",
    "enabled": true,
    "notify": [
      "0 = None",
      "1 = Email"
    ],
    "permissions": [
      "0 = PowerAdmin",
      "1 = RootAdmin",
      "2 = CustomAdmin"
    ],
    "fullPermissions": true,
    "allowSiteChanges": true,
    "allowPublishingChanges": true,
    "allowConnectionChanges": true,
    "allowViewingReportingInfo": true,
    "allowViewingSiteInfo": true,
    "allowViewingPolicyInfo": true,
    "allowSessionManagement": true,
    "allowDeviceManagementChanges": true,
    "allowPolicyChanges": true,
    "allowAllSites": true
  }'

204

401

404

No body

No Content

Delete

delete

Path parameters

idinteger · int32required

Admin Account ID

Query parameters

forceDeleteboolean

Force Delete the Admin Account

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/AdminAccount/{id}'

204

401

404

No body

No Content

List

Create

Show child attributes

Get

Update

Delete