Administrators

List

Retrieve Admin Account(s).

GET/api/AdminAccount

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Parallels RAS administrator user or group name.

typeAdminType (enum)

Admin Type

0 = User,1 = Group,2 = UserGroup

notifyAdminNotify (enum)

Admin Notify

0 = None,1 = Email

enabledboolean

Whether this administrator is enabled or disabled in the farm.

emailnullable string

The user email address.

mobilenullable string

The user mobile phone number.

groupNamenullable string

Group name.

fullPermissionsboolean

Whether the "Full Permissions" option is enabled or disabled.

permissionsPermissionType (enum)

Administrator type

0 = PowerAdmin,1 = RootAdmin,2 = CustomAdmin

Request

JavaScriptCurlPython

const response = await fetch('/api/AdminAccount', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-11-07T07:29:43.829Z",
    "timeLastMod": "2024-11-07T07:29:43.829Z",
    "name": "text",
    "type": [
      "0 = User",
      "1 = Group",
      "2 = UserGroup"
    ],
    "notify": [
      "0 = None",
      "1 = Email"
    ],
    "enabled": false,
    "email": "text",
    "mobile": "text",
    "groupName": "text",
    "fullPermissions": false,
    "permissions": [
      "0 = PowerAdmin",
      "1 = RootAdmin",
      "2 = CustomAdmin"
    ]
  }
]

Create

Create a new Admin Account.

POST/api/AdminAccount

Body

application/json; api-version=1.0

Admin Account settings

name*nullable string

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.

notifyAdminNotify (enum)

Admin Notify

0 = None,1 = Email

permissionsPermissionType (enum)

Administrator type

0 = PowerAdmin,1 = RootAdmin,2 = CustomAdmin

Response

201401409

Created

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Parallels RAS administrator user or group name.

typeAdminType (enum)

Admin Type

0 = User,1 = Group,2 = UserGroup

notifyAdminNotify (enum)

Admin Notify

0 = None,1 = Email

enabledboolean

Whether this administrator is enabled or disabled in the farm.

emailnullable string

The user email address.

mobilenullable string

The user mobile phone number.

groupNamenullable string

Group name.

fullPermissionsboolean

Whether the "Full Permissions" option is enabled or disabled.

permissionsPermissionType (enum)

Administrator type

0 = PowerAdmin,1 = RootAdmin,2 = CustomAdmin

Request

JavaScriptCurlPython

const response = await fetch('/api/AdminAccount', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

201401409

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T07:29:43.829Z",
  "timeLastMod": "2024-11-07T07:29:43.829Z",
  "name": "text",
  "type": [
    "0 = User",
    "1 = Group",
    "2 = UserGroup"
  ],
  "notify": [
    "0 = None",
    "1 = Email"
  ],
  "enabled": false,
  "email": "text",
  "mobile": "text",
  "groupName": "text",
  "fullPermissions": false,
  "permissions": [
    "0 = PowerAdmin",
    "1 = RootAdmin",
    "2 = CustomAdmin"
  ]
}

Get

Retrieve an Admin Account by ID.

GET/api/AdminAccount/{id}

Path parameters

id*integer (int32)

Admin Account ID

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

namenullable string

Parallels RAS administrator user or group name.

typeAdminType (enum)

Admin Type

0 = User,1 = Group,2 = UserGroup

notifyAdminNotify (enum)

Admin Notify

0 = None,1 = Email

enabledboolean

Whether this administrator is enabled or disabled in the farm.

emailnullable string

The user email address.

mobilenullable string

The user mobile phone number.

groupNamenullable string

Group name.

fullPermissionsboolean

Whether the "Full Permissions" option is enabled or disabled.

permissionsPermissionType (enum)

Administrator type

0 = PowerAdmin,1 = RootAdmin,2 = CustomAdmin

Request

JavaScriptCurlPython

const response = await fetch('/api/AdminAccount/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-11-07T07:29:43.829Z",
  "timeLastMod": "2024-11-07T07:29:43.829Z",
  "name": "text",
  "type": [
    "0 = User",
    "1 = Group",
    "2 = UserGroup"
  ],
  "notify": [
    "0 = None",
    "1 = Email"
  ],
  "enabled": false,
  "email": "text",
  "mobile": "text",
  "groupName": "text",
  "fullPermissions": false,
  "permissions": [
    "0 = PowerAdmin",
    "1 = RootAdmin",
    "2 = CustomAdmin"
  ]
}

Update

Update Admin Account settings.

PUT/api/AdminAccount/{id}

Path parameters

id*integer (int32)

Admin Account ID

Body

application/json; api-version=1.0

Admin Account settings

emailnullable string

Parallels RAS administrator email address.

mobilenullable string

Parallels RAS administrator mobile phone number.

enablednullable boolean

Enable or disable the specified administrator account.

notifyAdminNotify (enum)

Admin Notify

0 = None,1 = Email

permissionsPermissionType (enum)

Administrator type

0 = PowerAdmin,1 = RootAdmin,2 = CustomAdmin

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/AdminAccount/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

Delete

DELETE/api/AdminAccount/{id}

Path parameters

id*integer (int32)

Admin Account ID

Query parameters

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/AdminAccount/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}