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 Zero Trust Organization API

The Zero Trust Organization API from APIs.io Engineering Platform — 3 operation(s) for zero trust organization.

APIs.io Engineering Platform Zero Trust Organization API is one of 471 APIs that APIs.io Engineering Platform publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Zero Trust Organization. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

Requests are made against the base URL https://{bucketname}.s3.amazonaws.com.

6 operations 3 paths 27 schemas 2 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.0.0
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key, API Key, HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 4

APIs.io Engineering Platform Zero Trust Organization 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 6

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

Zero Trust Organization 6
GET
/accounts/{account_id}/access/organizations
APIs.io Engineering Platform Get your Zero Trust organization
zero-trust-organization-get-your-zero-trust-organization 1 param → 4XX200
POST
/accounts/{account_id}/access/organizations
APIs.io Engineering Platform Create your Zero Trust organization
zero-trust-organization-create-your-zero-trust-organization 1 param body → 4XX201
PUT
/accounts/{account_id}/access/organizations
APIs.io Engineering Platform Update your Zero Trust organization
zero-trust-organization-update-your-zero-trust-organization 1 param body → 4XX200
GET
/accounts/{account_id}/access/organizations/doh
APIs.io Engineering Platform Get your Zero Trust organization DoH settings
zero-trust-organization-get-your-zero-trust-organization-doh-settings 1 param → 4XX200
PUT
/accounts/{account_id}/access/organizations/doh
APIs.io Engineering Platform Update your Zero Trust organization DoH settings
zero-trust-organization-update-your-zero-trust-organization-doh-settings 1 param body → 4XX201
POST
/accounts/{account_id}/access/organizations/revoke_user
APIs.io Engineering Platform Revoke all Access tokens for a user
zero-trust-organization-revoke-all-access-tokens-for-a-user 1 param body → 4xx200

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are access_organizations (13 properties), access_service-tokens (7 properties), access_login_design (5 properties), access_api-response-common-failure (4 properties). Each schema is shown below with its type and property counts.

access_login_design
object
5 properties
access_timestamp
string
access_auto_redirect_to_identity
boolean
When set to true, users skip the identity provider selection step during login.
access_uuid
string
UUID
access_identifier
string
Identifier
access_custom_pages
object
2 properties
access_doh_jwt_duration
string
The duration the DoH JWT is valid for. Must be in the format 300ms or 2h45m. Valid time units are: ns, us (or µs), ms, s, m, h. Note that the maximum duration…
access_is_ui_read_only
boolean
Lock all settings as Read-Only in the Dashboard, regardless of user permission. Updates may only be made via the API or Terraform for this account when enabled.
access_allow_authenticate_via_warp
boolean
When set to true, users can authenticate via WARP for any application in your organization. Application settings will take precedence over this value.
access_name
string
The name of your Zero Trust organization.
access_session_duration
string
The amount of time that tokens issued for applications will be valid. Must be in the format 300ms or 2h45m. Valid time units are: ns, us (or µs), ms, s, m, h.
access_service-tokens
object
7 properties
access_api-response-common-failure
object
4 properties 4 required
access_ui_read_only_toggle_reason
string
A description of the reason why the UI read only field is being toggled.
access_user_seat_expiration_inactive_time
string
The amount of time a user seat is inactive before it expires. When the user seat exceeds the set time of inactivity, the user is removed as an active seat and…
access_auth_domain
string
The unique subdomain assigned to your Zero Trust organization.
access_messages
array
access_organizations
object
13 properties
access_empty_response
access_api-response-common
object
3 properties 3 required
access_warp_auth_session_duration
string
The amount of time that tokens issued for applications will be valid. Must be in the format 30m or 2h45m. Valid time units are: m, h.
access_single_response
access_schemas-single_response
access_schemas-name
string
The name of the service token.
access_duration
string
The duration for how long the service token will be valid. Must be in the format 300ms or 2h45m. Valid time units are: ns, us (or µs), ms, s, m, h. The default…
access_client_id
string
The Client ID for the service token. Access will check for this value in the CF-Access-Client-ID request header.
access_api-response-single
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-zero-trust-organization-api-openapi.yml Raw ↑

Other APIs APIs.io Engineering Platform publishes across the network.

EasyCron
APIs.io Engineering Platform 2014 11 13 API
APIs.io Engineering Platform 2015 03 31 API
APIs.io Engineering Platform 2016 08 19 API
APIs.io Engineering Platform 2017 03 31 API
APIs.io Engineering Platform 2017 10 31 API
APIs.io Engineering Platform 2018 10 31 API
APIs.io Engineering Platform 2019 09 25 API
APIs.io Engineering Platform 2019 09 30 API
APIs.io Engineering Platform 2020 04 22 API
APIs.io Engineering Platform 2020 06 30 API
Where this information came from

This is an independent, third-party profile of APIs.io Engineering Platform Zero Trust Organization 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.