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 Seats API

The Zero Trust Seats API from APIs.io Engineering Platform — 1 operation(s) for zero trust seats.

This API exposes 1 operation across 1 path, and defines 15 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.

1 operations 1 paths 15 schemas 1 PATCH

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 Seats 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 1

Across 1 path, the API surfaces 1 operation — 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Zero Trust Seats 1
PATCH
/accounts/{account_id}/access/seats
APIs.io Engineering Platform Update a user seat
zero-trust-seats-update-a-user-seat 1 param body → 4XX200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are access_seats (5 properties), access_result_info (4 properties), access_api-response-common-failure (4 properties), access_api-response-common (3 properties). Each schema is shown below with its type and property counts.

access_api-response-common
object
3 properties 3 required
access_seat
object
3 properties 3 required
access_api-response-common-failure
object
4 properties 4 required
access_gateway_seat
boolean
True if the seat is part of Gateway.
access_result_info
object
4 properties
access_seat_uid
string
The unique API identifier for the Zero Trust seat.
access_messages
array
access_seats_components-schemas-response_collection
access_api-response-collection
object
access_access_seat
boolean
True if the seat is part of Access.
access_seats_definition
array
3 required
access_seats
object
5 properties
access_timestamp
string
access_schemas-identifier
access_identifier
string
Identifier

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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