User Filters

Was this helpful?

Deprecated

Delete User filter

delete

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

Path parameters

idinteger · int32required

ID of the published resource to be updated

accountstringrequired

Account of User to be deleted from the filter

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/PubItems/{id}/UserFilters/{account}'

204

401

404

No Content

Deprecated

Get User filter

get

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

Path parameters

idinteger · int32required

ID of the published resource to be acquired.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/PubItems/{id}/UserFilters'

200

401

404

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

Success

Deprecated

Add User filter

post

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

Path parameters

idinteger · int32required

ID of the published resource to be updated

Body

Add a user or group account to the filter of type 'User' for the specified published resource

accountstring | nullableoptional

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

sidstring | nullableoptional

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

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

201

401

404

409

No Content

Created