Skip to content
Cloudflare API
Start here
API Reference
Zero Trust
Access
Applications

Policy Tests

Get the current status of a given Access policy test
zero_trust.access.applications.policy_tests.get(strpolicy_test_id, PolicyTestGetParams**kwargs) -> PolicyTestGetResponse
GET/accounts/{account_id}/access/policy-tests/{policy_test_id}
Start Access policy test
zero_trust.access.applications.policy_tests.create(PolicyTestCreateParams**kwargs) -> PolicyTestCreateResponse
POST/accounts/{account_id}/access/policy-tests
ModelsExpand Collapse
class PolicyTestGetResponse: …
id: Optional[str]

The UUID of the policy test.

maxLength64
percent_approved: Optional[int]

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

percent_blocked: Optional[int]

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

percent_errored: Optional[int]

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

percent_users_processed: Optional[int]

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

status: Optional[Literal["blocked", "processing", "exceeded time", "complete"]]

The status of the policy test.

One of the following:
"blocked"
"processing"
"exceeded time"
"complete"
total_users: Optional[int]

The total number of users in the user base.

users_approved: Optional[int]

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

users_blocked: Optional[int]

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

users_errored: Optional[int]

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

class PolicyTestCreateResponse: …
id: Optional[str]

The UUID of the policy test.

maxLength64
status: Optional[Literal["success"]]

The status of the policy test request.

Policy TestsUsers

Get an Access policy test users page
zero_trust.access.applications.policy_tests.users.list(strpolicy_test_id, UserListParams**kwargs) -> SyncV4PagePaginationArray[UserListResponse]
GET/accounts/{account_id}/access/policy-tests/{policy_test_id}/users
ModelsExpand Collapse
class UserListResponse: …
id: Optional[str]

UUID.

maxLength36
email: Optional[str]

The email of the user.

formatemail
name: Optional[str]

The name of the user.

status: Optional[Literal["approved", "blocked", "error"]]

Policy evaluation result for an individual user.

One of the following:
"approved"
"blocked"
"error"