> For the complete documentation index, see [llms.txt](https://docs.parallels.com/landing/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.parallels.com/landing/ras-rest-api-guide/v21/api-reference/farm-settings/administrators.md).

# Administrators

## List

> Retrieve Admin Account(s).

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/AdminAccount":{"get":{"tags":["1-Farm settings//Administrators"],"summary":"List","description":"Retrieve Admin Account(s).","operationId":"374d63f1-34af-4d21-9506-e41c3b4ea34f","parameters":[{"name":"Name","in":"query","description":"Admin Account Name (optional)","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json; api-version=1.0":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AdminAccount"}}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"AdminAccount":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"adminCreate":{"type":"string","description":"<para type=\"description\">User who created the object.</para>","nullable":true},"adminLastMod":{"type":"string","description":"<para type=\"description\">User who last modified the object.</para>","nullable":true},"timeCreate":{"type":"string","description":"<para type=\"description\">Time when the object was created.</para>","format":"date-time"},"timeLastMod":{"type":"string","description":"<para type=\"description\">Time when the object was last modified.</para>","format":"date-time"},"name":{"type":"string","description":"<para type=\"description\">Parallels RAS administrator user or group name.</para>","nullable":true},"type":{"$ref":"#/components/schemas/AdminType"},"notify":{"$ref":"#/components/schemas/AdminNotify"},"enabled":{"type":"boolean","description":"<para type=\"description\">Whether this administrator is enabled or disabled in the farm.</para>"},"email":{"type":"string","description":"<para type=\"description\">The user email address.</para>","nullable":true},"mobile":{"type":"string","description":"<para type=\"description\">The user mobile phone number.</para>","nullable":true},"groupName":{"type":"string","description":"<para type=\"description\">Group name.</para>","nullable":true},"fullPermissions":{"type":"boolean","description":"<para type=\"description\">Whether the \"Full Permissions\" option is enabled or disabled.</para>"},"permissions":{"$ref":"#/components/schemas/PermissionType"}},"additionalProperties":false,"description":"<para type=\"synopsis\">RAS Admin</para>\r\n<para type=\"description\"></para>"},"AdminType":{"enum":[["0 = User","1 = Group","2 = UserGroup"]],"type":"string","description":"<para type=\"synopsis\">Admin Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"AdminNotify":{"enum":[["0 = None","1 = Email"]],"type":"string","description":"<para type=\"synopsis\">Admin Notify</para>\r\n<para type=\"description\"></para>","format":"int32"},"PermissionType":{"enum":[["0 = PowerAdmin","1 = RootAdmin","2 = CustomAdmin"]],"type":"string","description":"<para type=\"synopsis\">Administrator type</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Create

> Create a new Admin Account.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/AdminAccount":{"post":{"tags":["1-Farm settings//Administrators"],"summary":"Create","description":"Create a new Admin Account.","operationId":"aa283c87-d52c-4ed0-821b-309c4384d10e","requestBody":{"description":"Admin Account settings","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/NewAdminAccount"}}}},"responses":{"201":{"description":"Created","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/AdminAccount"}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"409":{"description":"Conflict","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"NewAdminAccount":{"required":["name"],"type":"object","properties":{"name":{"maxLength":255,"minLength":1,"type":"string","description":"<para type=\"description\">The name of a user or group to add to the farm as an administrator.</para>","nullable":true},"email":{"type":"string","description":"<para type=\"description\">The user email address.</para>","nullable":true},"mobile":{"maxLength":50,"minLength":1,"type":"string","description":"<para type=\"description\">The user mobile phone number.</para>","nullable":true},"enabled":{"type":"boolean","description":"<para type=\"description\">Enables or disables this administrator in the farm.</para>"},"notify":{"$ref":"#/components/schemas/AdminNotify"},"permissions":{"$ref":"#/components/schemas/PermissionType"}},"additionalProperties":false,"description":"<para type=\"synopsis\">To create a new RAS administrator account</para>\r\n<para type=\"description\"></para>"},"AdminNotify":{"enum":[["0 = None","1 = Email"]],"type":"string","description":"<para type=\"synopsis\">Admin Notify</para>\r\n<para type=\"description\"></para>","format":"int32"},"PermissionType":{"enum":[["0 = PowerAdmin","1 = RootAdmin","2 = CustomAdmin"]],"type":"string","description":"<para type=\"synopsis\">Administrator type</para>\r\n<para type=\"description\"></para>","format":"int32"},"AdminAccount":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"adminCreate":{"type":"string","description":"<para type=\"description\">User who created the object.</para>","nullable":true},"adminLastMod":{"type":"string","description":"<para type=\"description\">User who last modified the object.</para>","nullable":true},"timeCreate":{"type":"string","description":"<para type=\"description\">Time when the object was created.</para>","format":"date-time"},"timeLastMod":{"type":"string","description":"<para type=\"description\">Time when the object was last modified.</para>","format":"date-time"},"name":{"type":"string","description":"<para type=\"description\">Parallels RAS administrator user or group name.</para>","nullable":true},"type":{"$ref":"#/components/schemas/AdminType"},"notify":{"$ref":"#/components/schemas/AdminNotify"},"enabled":{"type":"boolean","description":"<para type=\"description\">Whether this administrator is enabled or disabled in the farm.</para>"},"email":{"type":"string","description":"<para type=\"description\">The user email address.</para>","nullable":true},"mobile":{"type":"string","description":"<para type=\"description\">The user mobile phone number.</para>","nullable":true},"groupName":{"type":"string","description":"<para type=\"description\">Group name.</para>","nullable":true},"fullPermissions":{"type":"boolean","description":"<para type=\"description\">Whether the \"Full Permissions\" option is enabled or disabled.</para>"},"permissions":{"$ref":"#/components/schemas/PermissionType"}},"additionalProperties":false,"description":"<para type=\"synopsis\">RAS Admin</para>\r\n<para type=\"description\"></para>"},"AdminType":{"enum":[["0 = User","1 = Group","2 = UserGroup"]],"type":"string","description":"<para type=\"synopsis\">Admin Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Get

> Retrieve an Admin Account by ID.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/AdminAccount/{id}":{"get":{"tags":["1-Farm settings//Administrators"],"summary":"Get","description":"Retrieve an Admin Account by ID.","operationId":"d23e1fac-2113-44e1-881a-321761340712","parameters":[{"name":"id","in":"path","description":"Admin Account ID","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/AdminAccount"}}}},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"AdminAccount":{"type":"object","properties":{"id":{"type":"integer","description":"<para type=\"description\">ID of the object.</para>","format":"int32"},"adminCreate":{"type":"string","description":"<para type=\"description\">User who created the object.</para>","nullable":true},"adminLastMod":{"type":"string","description":"<para type=\"description\">User who last modified the object.</para>","nullable":true},"timeCreate":{"type":"string","description":"<para type=\"description\">Time when the object was created.</para>","format":"date-time"},"timeLastMod":{"type":"string","description":"<para type=\"description\">Time when the object was last modified.</para>","format":"date-time"},"name":{"type":"string","description":"<para type=\"description\">Parallels RAS administrator user or group name.</para>","nullable":true},"type":{"$ref":"#/components/schemas/AdminType"},"notify":{"$ref":"#/components/schemas/AdminNotify"},"enabled":{"type":"boolean","description":"<para type=\"description\">Whether this administrator is enabled or disabled in the farm.</para>"},"email":{"type":"string","description":"<para type=\"description\">The user email address.</para>","nullable":true},"mobile":{"type":"string","description":"<para type=\"description\">The user mobile phone number.</para>","nullable":true},"groupName":{"type":"string","description":"<para type=\"description\">Group name.</para>","nullable":true},"fullPermissions":{"type":"boolean","description":"<para type=\"description\">Whether the \"Full Permissions\" option is enabled or disabled.</para>"},"permissions":{"$ref":"#/components/schemas/PermissionType"}},"additionalProperties":false,"description":"<para type=\"synopsis\">RAS Admin</para>\r\n<para type=\"description\"></para>"},"AdminType":{"enum":[["0 = User","1 = Group","2 = UserGroup"]],"type":"string","description":"<para type=\"synopsis\">Admin Type</para>\r\n<para type=\"description\"></para>","format":"int32"},"AdminNotify":{"enum":[["0 = None","1 = Email"]],"type":"string","description":"<para type=\"synopsis\">Admin Notify</para>\r\n<para type=\"description\"></para>","format":"int32"},"PermissionType":{"enum":[["0 = PowerAdmin","1 = RootAdmin","2 = CustomAdmin"]],"type":"string","description":"<para type=\"synopsis\">Administrator type</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Update

> Update Admin Account settings.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/AdminAccount/{id}":{"put":{"tags":["1-Farm settings//Administrators"],"summary":"Update","description":"Update Admin Account settings.","operationId":"557ba6bb-4f53-4b8f-b4de-3a508a93d372","parameters":[{"name":"id","in":"path","description":"Admin Account ID","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"description":"Admin Account settings","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/SetAdminAccount"}}}},"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"SetAdminAccount":{"type":"object","properties":{"email":{"type":"string","description":"<para type=\"description\">Parallels RAS administrator email address.</para>","nullable":true},"mobile":{"maxLength":50,"minLength":0,"type":"string","description":"<para type=\"description\">Parallels RAS administrator mobile phone number.</para>","nullable":true},"enabled":{"type":"boolean","description":"<para type=\"description\">Enable or disable the specified administrator account.</para>","nullable":true},"notify":{"$ref":"#/components/schemas/AdminNotify"},"permissions":{"$ref":"#/components/schemas/PermissionType"}},"additionalProperties":false,"description":"<para type=\"synopsis\">Update a RAS administrator account</para>\r\n<para type=\"description\"></para>"},"AdminNotify":{"enum":[["0 = None","1 = Email"]],"type":"string","description":"<para type=\"synopsis\">Admin Notify</para>\r\n<para type=\"description\"></para>","format":"int32"},"PermissionType":{"enum":[["0 = PowerAdmin","1 = RootAdmin","2 = CustomAdmin"]],"type":"string","description":"<para type=\"synopsis\">Administrator type</para>\r\n<para type=\"description\"></para>","format":"int32"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```

## Delete

> Deletes the Admin Account.

```json
{"openapi":"3.0.1","info":{"title":"Parallels RAS - REST API v1.0","version":"1.0"},"paths":{"/api/AdminAccount/{id}":{"delete":{"tags":["1-Farm settings//Administrators"],"summary":"Delete","description":"Deletes the Admin Account.","operationId":"e720e8f6-37c1-42b2-9b6a-9f657b87c6b1","parameters":[{"name":"forceDelete","in":"query","description":"Force Delete the Admin Account","schema":{"type":"boolean"}},{"name":"id","in":"path","description":"Admin Account ID","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json; api-version=1.0":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.parallels.com/landing/ras-rest-api-guide/v21/api-reference/farm-settings/administrators.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.