User Filters

Last updated 10 months ago

Was this helpful?

Get User filter

Retrieve the filtered user accounts device names for the specified published resource. Deprecated path - Use Criteria section instead.

GET/api/PubItems/{id}/UserFilters

Path parameters

id*integer (int32)

ID of the published resource to be acquired.

Response

Success

Body

accountnullable string

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

typeenum

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

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

Response

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

Add User filter

Add a User account to the filter of type 'User' for the specified published resource. Deprecated path - Use Criteria section instead.

POST/api/PubItems/{id}/UserFilters

Path parameters

id*integer (int32)

ID of the published resource to be updated

Body

Published item user filter configuration

accountnullable string

The name of the user/group account to add to the filter.

sidnullable string

The SID of the user/group account to add to the filter.

Response

Created

Request

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

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Delete User filter

Delete a User account from the filter of type 'User' for the specified published resource. Deprecated path - Use Criteria section instead.

DELETE/api/PubItems/{id}/UserFilters/{account}

Path parameters

id*integer (int32)

ID of the published resource to be updated

account*string

Account of User to be deleted from the filter

Response

No Content

Request

const response = await fetch('/api/PubItems/{id}/UserFilters/{account}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "type": "text",
  "title": "text",
  "status": 1,
  "detail": "text",
  "instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}