Policy Tests

Get the current status of a given Access policy test

GET/accounts/{account_id}/access/policy-tests/{policy_test_id}

Start Access policy test

POST/accounts/{account_id}/access/policy-tests

ModelsExpand Collapse

PolicyTestGetResponse = object { id, percent_approved, percent_blocked, 7 more }

id: optional string

The UUID of the policy test.

maxLength64

percent_approved: optional number

The percentage of (processed) users approved based on policy evaluation results.

percent_blocked: optional number

The percentage of (processed) users blocked based on policy evaluation results.

percent_errored: optional number

The percentage of (processed) users errored based on policy evaluation results.

percent_users_processed: optional number

The percentage of users processed so far (of the entire user base).

status: optional "blocked" or "processing" or "exceeded time" or "complete"

The status of the policy test.

One of the following:

"blocked"

"processing"

"exceeded time"

"complete"

total_users: optional number

The total number of users in the user base.

users_approved: optional number

The number of (processed) users approved based on policy evaluation results.

users_blocked: optional number

The number of (processed) users blocked based on policy evaluation results.

users_errored: optional number

The number of (processed) users errored based on policy evaluation results.

PolicyTestCreateResponse = object { id, status }

id: optional string

The UUID of the policy test.

maxLength64

status: optional "success"

The status of the policy test request.

Policy TestsUsers

Get an Access policy test users page

GET/accounts/{account_id}/access/policy-tests/{policy_test_id}/users

ModelsExpand Collapse

UserListResponse = object { id, email, name, status }

id: optional string

UUID.

maxLength36

email: optional string

The email of the user.

formatemail

name: optional string

The name of the user.

status: optional "approved" or "blocked" or "error"

Policy evaluation result for an individual user.

One of the following:

"approved"

"blocked"

"error"