Zero Trust
zero_trust
Access
zero_trust.access
zero_trust.access.applications
Methods
Adds a new application to Access.
Deletes an application from Access.
Fetches information about an Access application.
Lists all Access applications in an account or zone.
Revokes all tokens issued for an application.
Updates an Access application.
Domain types
The identity providers selected for application.
Identifier.
Configuration for provisioning to this application via SCIM. This is currently in closed beta.
The application type.
The action Access will take if a user matches this policy. Infrastructure application policies can only use the Allow action.
The format of the name identifier sent to the SaaS application.
Attributes for configuring HTTP Basic authentication scheme for SCIM provisioning to an application.
Attributes for configuring OAuth 2 authentication scheme for SCIM provisioning to an application.
Attributes for configuring OAuth Bearer Token authentication scheme for SCIM provisioning to an application.
Transformations and filters applied to resources before they are provisioned in the remote SCIM service.
A domain that Access will secure.
zero_trust.access.applications.cas
Methods
Generates a new short-lived certificate CA and public key.
Deletes a short-lived certificate CA.
Fetches a short-lived certificate CA and its public key.
Lists short-lived certificate CAs and their public keys.
Domain types
zero_trust.access.applications.policies
Methods
Creates a policy applying exclusive to a single application that defines the users or groups who can reach it. We recommend creating a reusable policy instead and subsequently referencing its ID in the application's 'policies' array.
Deletes an Access policy specific to an application. To delete a reusable policy, use the /account or zones/{account or zone_id}/policies/{uid} endpoint.
Fetches a single Access policy configured for an application. Returns both exclusively owned and reusable policies used by the application.
Lists Access policies configured for an application. Returns both exclusively scoped and reusable policies used by the application.
Updates an Access policy specific to an application. To update a reusable policy, use the /account or zones/{account or zone_id}/policies/{uid} endpoint.
Domain types
Enforces a device posture rule has run successfully
Matches an Access group.
Matches any valid Access Service Token
Enforce different MFA options
Matches an Azure group. Requires an Azure identity provider.
Matches any valid client certificate.
Matches a specific country
Match an entire email domain.
Matches an email address from a list.
Matches a specific email.
Matches everyone.
Create Allow or Block policies which evaluate the user based on custom criteria.
Matches a Github organization. Requires a Github identity provider.
Matches an Access group.
Matches a group in Google Workspace. Requires a Google Workspace identity provider.
Matches an IP address from a list.
Matches an IP address block.
Matches an Okta group. Requires an Okta identity provider.
Matches a SAML group. Requires a SAML identity provider.
Matches a specific Access Service Token
zero_trust.access.applications.policy_tests
Methods
Starts an Access policy test.
Fetches the current status of a given Access policy test.
zero_trust.access.applications.policy_tests.users
Methods
Fetches a single page of user results from an Access policy test.
zero_trust.access.applications.settings
Methods
Updates Access application settings.
Updates Access application settings.
zero_trust.access.applications.user_policy_checks
Methods
Tests if a specific user has permission to access an application.
Domain types
zero_trust.access.bookmarks
Methods
Create a new Bookmark application.
Deletes a Bookmark application.
Fetches a single Bookmark application.
Lists Bookmark applications.
Updates a configured Bookmark application.
Domain types
zero_trust.access.certificates
Methods
Adds a new mTLS root certificate to Access.
Deletes an mTLS certificate.
Fetches a single mTLS certificate.
Lists all mTLS root certificates.
Updates a configured mTLS certificate.
Domain types
A fully-qualified domain name (FQDN).
zero_trust.access.certificates.settings
Methods
List all mTLS hostname settings for this account or zone.
Updates an mTLS certificate's hostname settings.
Domain types
zero_trust.access.custom_pages
Methods
Create a custom page
Delete a custom page
Fetches a custom page and also returns its HTML.
List custom pages
Update a custom page
Domain types
zero_trust.access.gateway_ca
Methods
Adds a new SSH Certificate Authority (CA).
Deletes an SSH Certificate Authority.
Lists SSH Certificate Authorities (CA).
zero_trust.access.groups
Methods
Creates a new Access group.
Deletes an Access group.
Fetches a single Access group.
Lists all Access groups.
Updates a configured Access group.
Domain types
zero_trust.access.infrastructure
zero_trust.access.infrastructure.targets
Methods
Removes one or more targets.
Removes one or more targets.
Adds one or more targets.
Create new target
Delete target
Get target
Lists and sorts an account’s targets. Filters are optional and are ANDed together.
Update target
zero_trust.access.keys
Methods
Gets the Access key rotation settings for an account.
Perfoms a key rotation for an account.
Updates the Access key rotation settings for an account.
zero_trust.access.logs
zero_trust.access.logs.access_requests
Methods
Gets a list of Access authentication audit logs for an account.
zero_trust.access.logs.scim
Domain types
zero_trust.access.logs.scim.updates
Methods
Lists Access SCIM update logs that maintain a record of updates made to User and Group resources synced to Cloudflare via the System for Cross-domain Identity Management (SCIM).
zero_trust.access.policies
Methods
Creates a new Access reusable policy.
Deletes an Access reusable policy.
Fetches a single Access reusable policy.
Lists Access reusable policies.
Updates a Access reusable policy.
Domain types
A group of email addresses that can approve a temporary authentication request.
zero_trust.access.service_tokens
Methods
Generates a new service token. Note: This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to rotate the Client Secret or create a new service token.
Deletes a service token.
Fetches a single service token.
Lists all service tokens.
Refreshes the expiration of a service token.
Generates a new Client Secret for a service token and revokes the old one.
Updates a configured service token.
Domain types
zero_trust.access.users
Methods
Gets a list of users for an account.
Domain types
zero_trust.access.users.active_sessions
Methods
Get an active session for a single user.
Get active sessions for a single user.
zero_trust.access.users.failed_logins
Methods
Get all failed login attempts for a single user.
zero_trust.access.users.last_seen_identity
Methods
Get last seen identity for a single user.
Domain types
Connectivity Settings
zero_trust.connectivity_settings
Methods
Updates the Zero Trust Connectivity Settings for the given account.
Gets the Zero Trust Connectivity Settings for the given account.
Devices
zero_trust.devices
Methods
Fetches a single WARP device. Not supported when multi-user mode is enabled for the account.
Deprecated: please use one of the following endpoints instead:
- GET /accounts/{account_id}/devices/physical-devices/{device_id}
- GET /accounts/{account_id}/devices/registrations/{registration_id}
List WARP devices. Not supported when multi-user mode is enabled for the account.
Deprecated: please use one of the following endpoints instead:
- GET /accounts/{account_id}/devices/physical-devices
- GET /accounts/{account_id}/devices/registrations
Domain types
zero_trust.devices.devices
Methods
Deletes a WARP device.
Fetches a single WARP device.
Lists WARP devices.
Revokes all WARP registrations associated with the specified device.
zero_trust.devices.dex_tests
Methods
Create a DEX test.
Delete a Device DEX test. Returns the remaining device dex tests for the account.
Fetch a single DEX test.
Fetch all DEX tests
Update a DEX test.
Domain types
The configuration object which contains the details for the WARP client to conduct the test.
zero_trust.devices.fleet_status
Methods
Get the live status of a latest device given device_id from the device_state table
zero_trust.devices.networks
Methods
Creates a new device managed network.
Deletes a device managed network and fetches a list of the remaining device managed networks for an account.
Fetches details for a single managed network.
Fetches a list of managed networks for an account.
Updates a configured device managed network.
Domain types
zero_trust.devices.override_codes
Methods
Fetches one-time use admin override codes for a registration. This relies on the Admin Override setting being enabled in your device configuration.
Fetches a one-time use admin override code for a device. This relies on the Admin Override setting being enabled in your device configuration. Not supported when multi-user mode is enabled for the account. Deprecated: please use GET /accounts/{account_id}/devices/registrations/{registration_id}/override_codes instead.
zero_trust.devices.policies
Domain types
zero_trust.devices.policies.custom
Methods
Creates a device settings profile to be applied to certain devices matching the criteria.
Deletes a device settings profile and fetches a list of the remaining profiles for an account.
Updates a configured device settings profile.
Fetches a device settings profile by ID.
Fetches a list of the device settings profiles for an account.
zero_trust.devices.policies.custom.excludes
Methods
Fetches the list of routes excluded from the WARP client's tunnel for a specific device settings profile.
Sets the list of routes excluded from the WARP client's tunnel for a specific device settings profile.