Security Principals

List

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

GET/api/PubItems/{id}/Rules/{ruleId}/Criteria/SecurityPrincipals

Path parameters

id*integer (int32)

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

ruleId*integer (int32)

The ID of the Rule to retrieve.

Response

Success

Body

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

Request

Response

Add

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

POST/api/PubItems/{id}/Rules/{ruleId}/Criteria/SecurityPrincipals

Path parameters

id*integer (int32)

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

ruleId*integer (int32)

The ID of the Rule to retrieve.

Body

SecurityPrincipal configuration.

accountnullable string

The name of the account to add to the Criteria.

sidnullable string

The SID of the account to add to the Criteria.

Response

Created

Request

Response

Remove

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

DELETE/api/PubItems/{id}/Rules/{ruleId}/Criteria/SecurityPrincipals

Path parameters

id*integer (int32)

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

ruleId*integer (int32)

The ID of the Rule to retrieve.

Body

SecurityPrincipal configuration.

accountnullable string

The name of the account to remove from the Criteria.

sidnullable string

The SID of the account to remove from the Criteria.

Response

No Content

Request

Response

Remove

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

DELETE/api/PubItems/{id}/Rules/{ruleId}/Criteria/SecurityPrincipals

Path parameters

id*integer (int32)

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

ruleId*integer (int32)

The ID of the Rule to retrieve.

Body

SecurityPrincipal configuration.

accountnullable string

The name of the account to remove from the Criteria.

sidnullable string

The SID of the account to remove from the Criteria.

Response

No Content

Request

Response

List

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

GET/api/PubItems/{id}/Rules/{ruleId}/Criteria/SecurityPrincipals

Path parameters

id*integer (int32)

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

ruleId*integer (int32)

The ID of the Rule to retrieve.

Response

Success

Body

accountnullable string

The name of the user/group account the filter is added to.

typeUserType (enum)

User Type

1 = User,2 = Group,3 = ForeignSecurityPrincipal,4 = Computer

sidnullable string

The SID of the user/group account the filter is added to.

Request

Response

Add

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

POST/api/PubItems/{id}/Rules/{ruleId}/Criteria/SecurityPrincipals

Path parameters

id*integer (int32)

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

ruleId*integer (int32)

The ID of the Rule to retrieve.

Body

SecurityPrincipal configuration.

accountnullable string

The name of the account to add to the Criteria.

sidnullable string

The SID of the account to add to the Criteria.

Response

Created

Request

Response

const response = await fetch('/api/PubItems/{id}/Rules/{ruleId}/Criteria/SecurityPrincipals', {
    method: 'DELETE',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}

const response = await fetch('/api/PubItems/{id}/Rules/{ruleId}/Criteria/SecurityPrincipals', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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

const response = await fetch('/api/PubItems/{id}/Rules/{ruleId}/Criteria/SecurityPrincipals', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}