APIs.io Engineering Platform Zero Trust Accounts API
The Zero Trust Accounts API from APIs.io Engineering Platform — 5 operation(s) for zero trust accounts.
This API exposes
11 operations
across 5 paths ,
and defines 36 schemas .
It is described by OpenAPI 3.0.0, at version 2015-07-09.
Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.
11 operations5 paths36 schemas5 GET2 PATCH1 POST3 PUT
The identity and technical contract details declared by the specification.
Authentication & Security 1
APIs.io Engineering Platform Zero Trust Accounts API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac — Amazon Signature authorization v4
Paths & Operations 11
Across 5 paths , the API surfaces 11 operations — 5 GET, 2 PATCH, 1 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
Zero Trust Accounts 11
GET
/accounts/{account_id}/devices/settings
APIs.io Engineering Platform Get device settings for a Zero Trust account
zero-trust-accounts-get-device-settings-for-zero-trust-account
1 param
→ 4XX200
PATCH
/accounts/{account_id}/devices/settings
APIs.io Engineering Platform Patch device settings for a Zero Trust account
zero-trust-accounts-patch-device-settings-for-the-zero-trust-account
1 param
body
→ 4XX200
PUT
/accounts/{account_id}/devices/settings
APIs.io Engineering Platform Update device settings for a Zero Trust account
zero-trust-accounts-update-device-settings-for-the-zero-trust-account
1 param
body
→ 4XX200
GET
/accounts/{account_id}/gateway
APIs.io Engineering Platform Get Zero Trust account information
zero-trust-accounts-get-zero-trust-account-information
1 param
→ 4XX200
POST
/accounts/{account_id}/gateway
APIs.io Engineering Platform Create Zero Trust account
zero-trust-accounts-create-zero-trust-account
1 param
→ 4XX200
GET
/accounts/{account_id}/gateway/configuration
APIs.io Engineering Platform Get Zero Trust account configuration
zero-trust-accounts-get-zero-trust-account-configuration
1 param
→ 4XX200
PATCH
/accounts/{account_id}/gateway/configuration
APIs.io Engineering Platform Patch Zero Trust account configuration
zero-trust-accounts-patch-zero-trust-account-configuration
1 param
body
→ 4XX200
PUT
/accounts/{account_id}/gateway/configuration
APIs.io Engineering Platform Update Zero Trust account configuration
zero-trust-accounts-update-zero-trust-account-configuration
1 param
body
→ 4XX200
GET
/accounts/{account_id}/gateway/configuration/custom_certificate
APIs.io Engineering Platform Get Zero Trust certificate configuration
zero-trust-accounts-get-zero-trust-certificate-configuration
1 param
→ 4XX200
GET
/accounts/{account_id}/gateway/logging
APIs.io Engineering Platform Get logging settings for the Zero Trust account
zero-trust-accounts-get-logging-settings-for-the-zero-trust-account
1 param
→ 4XX200
PUT
/accounts/{account_id}/gateway/logging
APIs.io Engineering Platform Update Zero Trust account logging settings
zero-trust-accounts-update-logging-settings-for-the-zero-trust-account
1 param
body
→ 4XX200
Schemas 36
The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are zero-trust-gateway_block-page-settings (9 properties), teams-devices_zero-trust-account-device-settings (5 properties), teams-devices_api-response-common (4 properties), zero-trust-gateway_api-response-common-failure (4 properties). Each schema is shown below with its type and property counts.
zero-trust-gateway_block-page-settings
object
Block page layout settings.
9 properties
zero-trust-gateway_gateway_tag
string
Gateway internal ID.
zero-trust-gateway_timestamp
string
teams-devices_api-response-common-failure
object
4 properties4 required
zero-trust-gateway_gateway-account-logging-settings-response
object
zero-trust-gateway_api-response-single
object
zero-trust-gateway_gateway_account
object
zero-trust-gateway_fips-settings
object
FIPS settings.
1 property
zero-trust-gateway_gateway-account-logging-settings
object
2 properties
zero-trust-gateway_api-response-common-failure
object
4 properties4 required
zero-trust-gateway_enabled_upload_phase
boolean
Enable anti-virus scanning on uploads.
zero-trust-gateway_gateway-account-settings
object
account settings.
1 property
teams-devices_zero-trust-account-device-settings
object
5 properties
zero-trust-gateway_api-response-common
object
3 properties3 required
teams-devices_api-response-common
object
4 properties4 required
zero-trust-gateway_cf_account_id
string
Cloudflare account ID.
zero-trust-gateway_activity-log-settings
object
Activity log settings.
1 property
zero-trust-gateway_identifier
string
zero-trust-gateway_body-scanning-settings
object
DLP body scanning settings.
1 property
zero-trust-gateway_gateway_account_config
object
zero-trust-gateway_messages
array
zero-trust-gateway_extended-email-matching
object
Extended e-mail matching settings.
1 property
zero-trust-gateway_enabled_download_phase
boolean
Enable anti-virus scanning on downloads.
zero-trust-gateway_protocol-detection
object
Protocol Detection settings.
1 property
teams-devices_api-response-single
object
zero-trust-gateway_anti-virus-settings
object
Anti-virus settings.
4 properties
zero-trust-gateway_certificate-settings
object
Certificate settings for Gateway TLS interception. If not specified, the Cloudflare Root CA will be used.
1 property1 required
zero-trust-gateway_browser-isolation-settings
object
Browser isolation settings.
2 properties
zero-trust-gateway_custom-certificate-settings
object
Custom certificate settings for BYO-PKI. (deprecated and replaced by certificate)
4 properties1 required
zero-trust-gateway_fail_closed
boolean
Block requests for files that cannot be scanned.
zero-trust-gateway_notification_settings
object
Configure a message to display on the user's device when an antivirus search is performed.
3 properties
zero-trust-gateway_provider_name
string
The name of the provider. Usually Cloudflare.
teams-devices_zero-trust-account-device-settings-response
object
teams-devices_messages
array
zero-trust-gateway_tls-settings
object
TLS interception settings.
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Zero Trust Accounts
