SupportDocumentation

Administrators

List

get

Retrieve Admin Account(s).

Query parameters
NamestringOptional

Admin Account Name (optional)

Responses
200
Success
application/json; api-version=1.0
get
GET /api/AdminAccount HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-07-04T19:17:10.497Z",
    "timeLastMod": "2025-07-04T19:17:10.497Z",
    "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"
    ]
  }
]

Create

post

Create a new Admin Account.

Body

To create a new RAS administrator account

namestring | nullableRequired

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

emailstring | nullableOptional

The user email address.

mobilestring | nullableOptional

The user mobile phone number.

enabledbooleanOptional

Enables or disables this administrator in the farm.

notifystring · enumOptional

Admin Notify

Possible values:
fullPermissionsbooleanOptionalDeprecated

Enable or disable the "Full Permissions" option.

permissionsstring · enumOptional

Administrator type

Possible values:
allowSiteChangesbooleanOptionalDeprecated

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

allowPublishingChangesbooleanOptionalDeprecated

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

allowConnectionChangesbooleanOptionalDeprecated

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

allowViewingReportingInfobooleanOptionalDeprecated

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

allowViewingSiteInfobooleanOptionalDeprecated

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

allowViewingPolicyInfobooleanOptionalDeprecated

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

allowSessionManagementbooleanOptionalDeprecated

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

allowDeviceManagementChangesbooleanOptionalDeprecated

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

allowPolicyChangesbooleanOptionalDeprecated

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

allowAllSitesbooleanOptionalDeprecated

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.

Responses
201
Created
application/json; api-version=1.0
post
POST /api/AdminAccount HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 162

{
  "name": "text",
  "email": "text",
  "mobile": "text",
  "enabled": true,
  "notify": [
    "0 = None",
    "1 = Email"
  ],
  "permissions": [
    "0 = PowerAdmin",
    "1 = RootAdmin",
    "2 = CustomAdmin"
  ]
}
{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-07-04T19:17:10.497Z",
  "timeLastMod": "2025-07-04T19:17:10.497Z",
  "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"
  ]
}

Get

get

Retrieve an Admin Account by ID.

Path parameters
idinteger · int32Required

Admin Account ID

Responses
200
Success
application/json; api-version=1.0
get
GET /api/AdminAccount/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-07-04T19:17:10.497Z",
  "timeLastMod": "2025-07-04T19:17:10.497Z",
  "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"
  ]
}

Update

put

Update Admin Account settings.

Path parameters
idinteger · int32Required

Admin Account ID

Body

Update a RAS administrator account

emailstring | nullableOptional

Parallels RAS administrator email address.

mobilestring | nullableOptional

Parallels RAS administrator mobile phone number.

enabledboolean | nullableOptional

Enable or disable the specified administrator account.

notifystring · enumOptional

Admin Notify

Possible values:
permissionsstring · enumOptional

Administrator type

Possible values:
fullPermissionsboolean | nullableOptionalDeprecated

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

allowSiteChangesboolean | nullableOptionalDeprecated

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

allowPublishingChangesboolean | nullableOptionalDeprecated

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

allowConnectionChangesboolean | nullableOptionalDeprecated

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

allowViewingReportingInfoboolean | nullableOptionalDeprecated

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

allowViewingSiteInfoboolean | nullableOptionalDeprecated

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

allowViewingPolicyInfoboolean | nullableOptionalDeprecated

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

allowSessionManagementboolean | nullableOptionalDeprecated

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

allowDeviceManagementChangesboolean | nullableOptionalDeprecated

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

allowPolicyChangesboolean | nullableOptionalDeprecated

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

allowAllSitesboolean | nullableOptionalDeprecated

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
204
No Content
put
PUT /api/AdminAccount/{id} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 148

{
  "email": "text",
  "mobile": "text",
  "enabled": true,
  "notify": [
    "0 = None",
    "1 = Email"
  ],
  "permissions": [
    "0 = PowerAdmin",
    "1 = RootAdmin",
    "2 = CustomAdmin"
  ]
}
No content

Delete

delete
Path parameters
idinteger · int32Required

Admin Account ID

Query parameters
forceDeletebooleanOptional

Force Delete the Admin Account

Responses
204
No Content
delete
DELETE /api/AdminAccount/{id} HTTP/1.1
Host: 
Accept: */*

No content
PreviousLogonNextCustom Permission

Last updated

Was this helpful?