Parallels REST API

Get User Group

Deprecated

Retrieves the user group list of the client policy settings with the specified ID. Deprecated path - Use Criteria section instead.

get

/api/ClientPolicies/{id}/UserGroup

Path parameters

idinteger int32required

Client Policy ID.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/ClientPolicies/{id}/UserGroup'

200

401

404

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

Success

Add User Group

Deprecated

Adds a user to the user group list of the client policy settings. Deprecated path - Use Criteria section instead.

post

/api/ClientPolicies/{id}/UserGroup

Path parameters

idinteger int32required

Client Policy ID.

Body

accountnullable string

The name of the user/group account.

sidnullable string

The SID of the user/group account.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/ClientPolicies/{id}/UserGroup' \
  --header 'Content-Type: application/json; api-version=1.0'

201

401

404

409

No body

Created

Remove User Group

Deprecated

Remove a user from the user group list of the client policy settings. Deprecated path - Use Criteria section instead.

delete

/api/ClientPolicies/{id}/UserGroup

Path parameters

idinteger int32required

Client Policy ID.

Body

accountnullable string

The name of the user/group account.

sidnullable string

The SID of the user/group account.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/ClientPolicies/{id}/UserGroup' \
  --header 'Content-Type: application/json; api-version=1.0'

204

401

404

No body

No Content