User Inclusion | Parallels REST API

Parallels REST API

SupportDocumentation

Get

get

Retrieves FSLogix Office Container User Inclusion List of a Site Defaults object.

Query parameters

siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to retrieve the FSLogix Office Container settings (optional).

Responses

application/json; api-version=1.0

object[]Optional

User filter

application/json; api-version=1.0

get

GET /api/RDSDefaultSettings/FSLogix/OfficeContainer/UserInclusion HTTP/1.1
Host: 
Accept: */*

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

Add

post

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

Query parameters

siteIdinteger · int32Optional

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

Add a user or group account to the FSLogix user inclusion/exclusion list

accountstring | nullableOptional

The name of the user/group account to add to the FSLogix Container.

sidstring | nullableOptional

The SID of the user/group account to add to the FSLogix Container.

Responses

application/json; api-version=1.0

post

POST /api/RDSDefaultSettings/FSLogix/OfficeContainer/UserInclusion 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 from the User Inclusion List of the FSLogix Office Container settings.

Query parameters

siteIdinteger · int32Optional

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

Remove a user from the FSLogix user inclusion list

accountstring | nullableOptional

The name of the user/group account to remove from the FSLogix Container.

sidstring | nullableOptional

The SID of the user/group account to remove from the FSLogix Container.

Responses

application/json; api-version=1.0

delete

DELETE /api/RDSDefaultSettings/FSLogix/OfficeContainer/UserInclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

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

No content