JUjumpcloud
Graph
Policies
Users

List the policy statuses for a user

This endpoint returns the policy results for a particular user.

Sample Request
curl -X GET https://console.jumpcloud.com/api/v2/users/{User_ID}/policystatuses \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
get/api/v2/users/{user_id}/policystatuses

Request

Query parameters

fieldsstring[]

The comma separated fields included in the returned records. If omitted, the default list of fields will be returned.

filterstring[]

A filter to apply to the query.

Filter structure: <field>:<operator>:<value>.

field = Populate with a valid field from an endpoint response.

operator = Supported operators are: eq, ne, gt, ge, lt, le, between, search, in. Note: v1 operators differ from v2 operators.

value = Populate with the value you want to search for. Is case sensitive. Supports wild cards.

EX: GET /api/v2/groups?filter=name:eq:Test+Group

limitinteger

The number of records to return at once. Limited to 100.

skipinteger

The offset into the records to return.

sortstring[]

The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending.

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Response

OK

detailstring

Details pertaining to the policy result.

endedAtstring date-time

The end of the policy application.

exitStatusinteger

The 32-bit unsigned exit status from the applying the policy.

idstring

ObjectId uniquely identifying a Policy Result.

policyIDstring

ObjectId uniquely identifying the parent Policy.

startedAtstring date-time

The start of the policy application.

statestring

Enumeration describing the state of the policy. Success, failed, or pending.

stdErrstring

The STDERR output from applying the policy.

stdOutstring

The STDOUT output from applying the policy.

successboolean

True if the policy was successfully applied; false otherwise.

systemIDstring

ObjectId uniquely identifying the parent System.

userObjectIdstring

ObjectId uniquely identifying the parent User.

Changes

No recorded changes to this operation across all 1 revision of this API.