Parallels REST API

Get

Retrieves FSLogix Office Container User Inclusion List of a session server with the specified ID.

get

/api/RDS/HostPool/{id}/FSLogix/OfficeContainer/UserInclusion

Path parameters

idinteger · int32required

The ID of a session server for which to retrieve the FSLogix Office Container settings.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/RDS/HostPool/{id}/FSLogix/OfficeContainer/UserInclusion'

200

401

404

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

Success

Add

Add a user to the User Inclusion List of the FSLogix Office Container settings.

post

/api/RDS/HostPool/{id}/FSLogix/OfficeContainer/UserInclusion

Path parameters

idinteger · int32required

The ID of a session server for which to modify the FSLogix Office Container settings.

Body

accountstring | nullable

<para type="description">The name of the user/group account to add to the FSLogix Container.</para>

sidstring | nullable

<para type="description">The SID of the user/group account to add to the FSLogix Container.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/RDS/HostPool/{id}/FSLogix/OfficeContainer/UserInclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "account": "text",
    "sid": "text"
  }'

201

401

404

409

No body

Created

Remove

Remove a user from the User Inclusion List of the FSLogix Office Container settings.

delete

/api/RDS/HostPool/{id}/FSLogix/OfficeContainer/UserInclusion

Path parameters

idinteger · int32required

The ID of a session server for which to modify the FSLogix Office Container settings.

Body

accountstring | nullable

<para type="description">The name of the user/group account to remove from the FSLogix Container.</para>

sidstring | nullable

<para type="description">The SID of the user/group account to remove from the FSLogix Container.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/RDS/HostPool/{id}/FSLogix/OfficeContainer/UserInclusion' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "account": "text",
    "sid": "text"
  }'

204

401

404

No body

No Content