Security Principals | Parallels REST API

Parallels REST API

Products Support Partners Documentation

List

get

Retrieve Criteria Security Principal List of a session server with the specified ID.

Path parameters

idinteger · int32required

The ID of a session server for which to retrieve the Criteria settings.

ruleIdinteger · int32required

The ID of the Rule to retrieve.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/ClientPolicies/{id}/Rules/{ruleId}/Criteria/SecurityPrincipals'

200

401

404

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

Success

Add

post

Add a user, group or machine to the Security Principal List of the Criteria settings.

Path parameters

idinteger · int32required

The ID of a session server for which to modify the Criteria settings.

ruleIdinteger · int32required

The ID of the Rule to retrieve.

Body

Add a user, group or machine account to the Criteria security principal list

accountstring | nullableoptional

The name of the account to add to the Criteria.

sidstring | nullableoptional

The SID of the account to add to the Criteria.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/ClientPolicies/{id}/Rules/{ruleId}/Criteria/SecurityPrincipals' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "account": "text",
    "sid": "text"
  }'

201

401

404

409

No Content

Created

Remove

delete

Remove a user, group or machine from the Security Principal List of the Criteria settings.

Path parameters

idinteger · int32required

The ID of a session server for which to modify the Criteria settings.

ruleIdinteger · int32required

The ID of the Rule to retrieve.

Body

Remove a user, group or machine from the Criteria security principal list

accountstring | nullableoptional

The name of the account to remove from the Criteria.

sidstring | nullableoptional

The SID of the account to remove from the Criteria.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/ClientPolicies/{id}/Rules/{ruleId}/Criteria/SecurityPrincipals' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "account": "text",
    "sid": "text"
  }'

204

401

404

No Content