Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
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.

This API exposes 6 operations across 3 paths, and defines 27 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.

6 operations 3 paths 27 schemas 2 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Zero Trust Organization 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 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_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_auth_domain
string
The unique subdomain assigned to your Zero Trust organization.
access_uuid
string
UUID
access_custom_pages
object
2 properties
access_auto_redirect_to_identity
boolean
When set to true, users skip the identity provider selection step during login.
access_identifier
string
Identifier
access_schemas-name
string
The name of the service token.
access_api-response-common-failure
object
4 properties 4 required
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_single_response
access_service-tokens
object
7 properties
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_schemas-single_response
access_api-response-common
object
3 properties 3 required
access_organizations
object
13 properties
access_messages
array
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_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_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_timestamp
string
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_login_design
object
5 properties
access_name
string
The name of your Zero Trust organization.
access_ui_read_only_toggle_reason
string
A description of the reason why the UI read only field is being toggled.
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_api-response-single
object
access_empty_response

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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