Administrators

PreviousLogon NextCustom Permission

Was this helpful?

List

Retrieve Admin Account(s).

get

/api/AdminAccount

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

[
  {
    "type": [
      "0 = User",
      "1 = Group",
      "2 = UserGroup"
    ],
    "notify": [
      "0 = None",
      "1 = Email"
    ],
    "permissions": [
      "0 = PowerAdmin",
      "1 = RootAdmin",
      "2 = CustomAdmin"
    ],
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-02-18T22:47:50.059Z",
    "timeLastMod": "2025-02-18T22:47:50.059Z",
    "name": "text",
    "enabled": true,
    "email": "text",
    "mobile": "text",
    "groupName": "text",
    "fullPermissions": true
  }
]

Success

Create

Create a new Admin Account.

post

/api/AdminAccount

Body

notifyenum

Admin Notify

Options: 0 = None,1 = Email

permissionsenum

Administrator type

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

namenullable stringrequired

The name of a user or group to add to the farm as an administrator.

emailnullable string

The user email address.

mobilenullable string

The user mobile phone number.

enabledboolean

Enables or disables this administrator in the farm.

fullPermissionsbooleanDeprecated

Enable or disable the "Full Permissions" option.

allowSiteChangesbooleanDeprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Enable or disable the "Allow Site changes" option.

allowPublishingChangesbooleanDeprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Enable or disable the "Allow Publishing changes" option.

allowConnectionChangesbooleanDeprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Enable or disable the "Allow Connection changes" option.

allowViewingReportingInfobooleanDeprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Enable or disable the "Allow viewing of RAS Reporting" option.

allowViewingSiteInfobooleanDeprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Enable or disable the "Allow viewing of Site Information" option.

allowViewingPolicyInfobooleanDeprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Enable or disable the "Allow viewing of Policy Information" option.

allowSessionManagementbooleanDeprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Enable or disable the "Allow Session Management" option.

allowDeviceManagementChangesbooleanDeprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Enable or disable the "Allow Device Management changes" option.

allowPolicyChangesbooleanDeprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Enable or disable the "Allow Policy changes" option.

allowAllSitesbooleanDeprecated

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

allowInSitesnullable object[]Deprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Specifies the list of site names (string array) which this administrator should be allowed to manage.

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 '{"notify":["0 = None","1 = Email"],"permissions":["0 = PowerAdmin","1 = RootAdmin","2 = CustomAdmin"],"name":"text","allowInSites":[{}]}'

201

401

409

{
  "type": [
    "0 = User",
    "1 = Group",
    "2 = UserGroup"
  ],
  "notify": [
    "0 = None",
    "1 = Email"
  ],
  "permissions": [
    "0 = PowerAdmin",
    "1 = RootAdmin",
    "2 = CustomAdmin"
  ],
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-02-18T22:47:50.059Z",
  "timeLastMod": "2025-02-18T22:47:50.059Z",
  "name": "text",
  "enabled": true,
  "email": "text",
  "mobile": "text",
  "groupName": "text",
  "fullPermissions": true
}

Created

Get

Retrieve an Admin Account by ID.

get

/api/AdminAccount/{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

{
  "type": [
    "0 = User",
    "1 = Group",
    "2 = UserGroup"
  ],
  "notify": [
    "0 = None",
    "1 = Email"
  ],
  "permissions": [
    "0 = PowerAdmin",
    "1 = RootAdmin",
    "2 = CustomAdmin"
  ],
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-02-18T22:47:50.059Z",
  "timeLastMod": "2025-02-18T22:47:50.059Z",
  "name": "text",
  "enabled": true,
  "email": "text",
  "mobile": "text",
  "groupName": "text",
  "fullPermissions": true
}

Success

Update

Update Admin Account settings.

put

/api/AdminAccount/{id}

Path parameters

idinteger int32required

Admin Account ID

Body

notifyenum

Admin Notify

Options: 0 = None,1 = Email

permissionsenum

Administrator type

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

emailnullable string

Parallels RAS administrator email address.

mobilenullable string

Parallels RAS administrator mobile phone number.

enablednullable boolean

Enable or disable the specified administrator account.

fullPermissionsnullable booleanDeprecated

Whether to grant the specified administrator full permissions in the farm. If set to False, permissions can be set individually.

allowSiteChangesnullable booleanDeprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Enable or disable the "Allow Site changes" option.

allowPublishingChangesnullable booleanDeprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Enable or disable the "Allow Publishing changes" option.

allowConnectionChangesnullable booleanDeprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Enable or disable the "Allow Connection changes" option.

allowViewingReportingInfonullable booleanDeprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Enable or disable the "Allow viewing of RAS Reporting" option.

allowViewingSiteInfonullable booleanDeprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Enable or disable the "Allow viewing of Site Information" option.

allowViewingPolicyInfonullable booleanDeprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Enable or disable the "Allow viewing of Policy Information" option.

allowSessionManagementnullable booleanDeprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Enable or disable the "Allow Session Management" option.

allowDeviceManagementChangesnullable booleanDeprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Enable or disable the "Allow Device Management changes" option.

allowPolicyChangesnullable booleanDeprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Enable or disable the "Allow Policy changes" option.

allowAllSitesnullable booleanDeprecated

Deprecated: use 'Set-RASPowerPermission' to set power admin permissions. Enable or disable the "All Sites" option. If enabled, the administrator can manage all sites in the farm. Otherwise, sites can be specified individually.

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 '{"notify":["0 = None","1 = Email"],"permissions":["0 = PowerAdmin","1 = RootAdmin","2 = CustomAdmin"]}'

204

401

404

No body

No Content

Delete

delete

/api/AdminAccount/{id}

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