How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Access Policy Tester API

The Access Policy Tester API from APIs.io Engineering Platform — 3 operation(s) for access policy tester.

This API exposes 3 operations across 3 paths, and defines 56 schemas. It is described by OpenAPI 3.2.0, at version 4.0.0.

Requests are made against the base URL https://api.cloudflare.com/client/v4.

3 operations 3 paths 56 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.0
Base URL
https://api.cloudflare.com/client/v4
Authentication
API Key, API Key, HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 4

APIs.io Engineering Platform Access Policy Tester API declares 4 security schemes for authenticating requests. An API key is passed in the header as X-Auth-Email (api_email). An API key is passed in the header as X-Auth-Key (api_key). It accepts HTTP bearer tokens (api_token). An API key is passed in the header as X-Auth-User-Service-Key (user_service_key).

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Access Policy Tester 3
POST
/accounts/{account_id}/access/policy-tests
APIs.io Engineering Platform Start Access policy test
access-policy-tests 1 param body → 200400
GET
/accounts/{account_id}/access/policy-tests/{policy_test_id}
APIs.io Engineering Platform Get the current status of a given Access policy…
access-policy-tests-get-an-update 2 params → 200400
GET
/accounts/{account_id}/access/policy-tests/{policy_test_id}/users
APIs.io Engineering Platform Get an Access policy test users page
access-policy-tests-get-a-user-page 2 params → 200400

Schemas 56

The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are access_policy_resp (14 properties), access_policy_update_resp (9 properties), access_policy_users (4 properties), access_api-response-common-failure (4 properties). Each schema is shown below with its type and property counts.

access_gsuite_group_rule
object
Matches a group in Google Workspace. Requires a Google Workspace identity provider.
1 property 1 required
access_email_rule
object
Matches a specific email.
1 property 1 required
access_email_list_rule
object
Matches an email address from a list.
1 property 1 required
access_external_evaluation_rule
object
Create Allow or Block policies which evaluate the user based on custom criteria.
1 property 1 required
access_api-response-common-failure
object
4 properties 4 required
access_schemas-require
array
Rules evaluated with an AND logical operator. To match the policy, a user must meet all of the Require rules.
access_policy_users_resp
array
Page of processed users.
access_percent_users_processed
integer
The percentage of users processed so far (of the entire user base).
access_approval_groups
array
Administrators who can approve a temporary authentication request.
access_schemas-uuid
string
The UUID of the policy
access_policy_users
object
4 properties
access_service_token_rule
object
Matches a specific Access Service Token
1 property 1 required
access_github_organization_rule
object
Matches a Github organization. Requires a Github identity provider.
1 property 1 required
access_policy_test_id
string
The UUID of the policy test.
access_schemas-exclude
array
Rules evaluated with a NOT logical operator. To match the policy, a user cannot meet any of the Exclude rules.
access_ip_rule
object
Matches an IP address block.
1 property 1 required
access_uuid
string
UUID
access_update_status
string
The status of the policy test.
access_azure_group_rule
object
Matches an Azure group. Requires an Azure identity provider.
1 property 1 required
access_policy_init_resp
object
2 properties
access_percent_approved
integer
The percentage of (processed) users approved based on policy evaluation results.
access_policy_components-schemas-name
string
The name of the Access policy.
access_users_components-schemas-name
string
The name of the user.
access_ip_list_rule
object
Matches an IP address from a list.
1 property 1 required
access_pages_processed
integer
The number of pages of (processed) users.
access_timestamp
string
access_domain_rule
object
Match an entire email domain.
1 property 1 required
access_percent_blocked
integer
The percentage of (processed) users blocked based on policy evaluation results.
access_user_result
string
Policy evaluation result for an individual user.
access_device_posture_rule
object
Enforces a device posture rule has run successfully
1 property 1 required
access_users_approved
integer
The number of (processed) users approved based on policy evaluation results.
access_rule
object
access_everyone_rule
object
Matches everyone.
1 property 1 required
access_purpose_justification_prompt
string
A custom message that will appear on the purpose justification screen.
access_any_valid_service_token_rule
object
Matches any valid Access Service Token
1 property 1 required
access_access_group_rule
object
Matches an Access group.
1 property 1 required
access_okta_group_rule
object
Matches an Okta group. Requires an Okta identity provider.
1 property 1 required
access_certificate_rule
object
Matches any valid client certificate.
1 property 1 required
access_total_users
integer
The total number of users in the user base.
access_purpose_justification_required
boolean
Require users to enter a justification when they log in to the application.
access_isolation_required
boolean
Require this application to be served in an isolated browser for users matching this policy. 'Client Web Isolation' must be on for the account in order to use…
access_status
string
The status of the policy test request.
access_include
array
Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.
access_identifier
string
Identifier
access_users_blocked
integer
The number of (processed) users blocked based on policy evaluation results.
access_policy_resp
object
14 properties
access_policy_update_resp
object
9 properties
access_saml_group_rule
object
Matches a SAML group. Requires a SAML identity provider.
1 property 1 required
access_approval_group
object
A group of email addresses that can approve a temporary authentication request.
3 properties 1 required
access_decision
string
The action Access will take if a user matches this policy.
access_country_rule
object
Matches a specific country
1 property 1 required
access_components-schemas-session_duration
string
The amount of time that tokens issued for the application will be valid. Must be in the format 300ms or 2h45m. Valid time units are: ns, us (or µs), ms, s, m,…
access_email
string
The email of the user.
access_messages
array
access_approval_required
boolean
Requires the user to request access from an administrator at the start of each session.
access_authentication_method_rule
object
Enforce different MFA options
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-access-policy-tester-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of APIs.io Engineering Platform Access Policy Tester API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.