Administrators

PreviousLogon NextCustom Permission

Was this helpful?

Get

get

Retrieve an Admin Account by ID.

Path parameters

idinteger · int32required

Admin Account ID

Responses

application/json; api-version=1.0

get

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

200

401

404

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-13T01:16:44.828Z",
  "timeLastMod": "2025-04-13T01:16:44.828Z",
  "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

Delete

delete

Path parameters

idinteger · int32required

Admin Account ID

Query parameters

forceDeletebooleanoptional

Force Delete the Admin Account

Responses

application/json; api-version=1.0

delete

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

204

401

404

No Content

List

get

Retrieve Admin Account(s).

Query parameters

Namestringoptional

Admin Account Name (optional)

Responses

application/json; api-version=1.0

get

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

200

401

404

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-04-13T01:16:44.828Z",
    "timeLastMod": "2025-04-13T01:16:44.828Z",
    "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

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

Available options:

fullPermissionsbooleanoptionalDeprecated

Enable or disable the "Full Permissions" option.

permissionsstring · enumoptional

Administrator type

Available options:

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.

allowInSitesobject[] | nullableoptionalDeprecated

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

post

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

201

401

409

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-13T01:16:44.828Z",
  "timeLastMod": "2025-04-13T01:16:44.828Z",
  "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

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

Available options:

permissionsstring · enumoptional

Administrator type

Available options:

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

application/json; api-version=1.0

put

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"
    ]
  }'

204

401

404

No Content

Get

Delete

List

Create

Show child attributes

Update