User Group | Parallels REST API

Deprecated

Get User Group

get

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

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

Deprecated

Add User Group

post

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

Path parameters

idinteger · int32required

Client Policy ID.

Body

Add a new User/Group criteria to the Client Policy

accountstring | nullableoptional

The name of the user/group account.

sidstring | nullableoptional

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' \
  --data '{
    "account": "text",
    "sid": "text"
  }'

201

401

404

409

No Content

Created

Deprecated

Remove User Group

delete

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

Path parameters

idinteger · int32required

Client Policy ID.

Body

Remove a new User/Group criteria from the Client Policy

accountstring | nullableoptional

The name of the user/group account.

sidstring | nullableoptional

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' \
  --data '{
    "account": "text",
    "sid": "text"
  }'

204

401

404

No Content