Assignment | Parallels REST API

Parallels REST API

SupportDocumentation

List

get

Retrieve Assignment List of an AVD Host Pool with the specified ID.

Path parameters

idinteger · int32Required

The ID of an AVD Host Pool for which to retrieve the Assignment settings.

Responses

application/json; api-version=1.0

object[]Optional

AVD Host Pool Assignment Settings

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/Assignment HTTP/1.1
Host: 
Accept: */*

[
  {
    "account": "text",
    "type": [
      "1 = User",
      "2 = Group",
      "3 = ForeignSecurityPrincipal",
      "4 = Computer"
    ],
    "sid": "text",
    "azureActiveDirectory": "text",
    "azureActiveDirectoryId": "text"
  }
]

Add

post

Add a user or group to the Assignment List of the AVD Host Pool.

Path parameters

idinteger · int32Required

The ID of an AVD Host Pool for which to modify the Assignment settings.

Body

Add a user or group account to the AVD Host Pool Assignment list

accountstring | nullableOptional

The name of the account to add to the Assignments.

sidstring | nullableOptional

The SID of the account to add to the Assignments.

Responses

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/Assignment HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}

No content

Remove

delete

Remove a user or group from the Assignment List of the AVD Host Pool.

Path parameters

idinteger · int32Required

The ID of an AVD Host Pool for which to modify the Assignment settings.

Body

Remove a user or group account from the AVD Host Pool Assignment list

accountstring | nullableOptional

The name of the account to remove from the Assignments.

sidstring | nullableOptional

The SID of the account to remove from the Assignments.

Responses

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/{id}/Assignment HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}

No content