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

The Zero Trust Users API from APIs.io Engineering Platform — 5 operation(s) for zero trust users.

This API exposes 5 operations across 5 paths, and defines 30 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.

5 operations 5 paths 30 schemas 5 GET

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 Users 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 5

Across 5 paths, the API surfaces 5 operations — 5 GET. Each is listed below with its method, path, parameters, and response codes.

Zero Trust Users 5
GET
/accounts/{account_id}/access/users
APIs.io Engineering Platform Get users
zero-trust-users-get-users 1 param → 4XX200
GET
/accounts/{account_id}/access/users/{user_id}/active_sessions
APIs.io Engineering Platform Get active sessions
zero-trust-users-get-active-sessions 2 params → 4XX200
GET
/accounts/{account_id}/access/users/{user_id}/active_sessions/{nonce}
APIs.io Engineering Platform Get single active session
zero-trust-users-get-active-session 3 params → 4XX200
GET
/accounts/{account_id}/access/users/{user_id}/failed_logins
APIs.io Engineering Platform Get failed logins
zero-trust-users-get-failed-logins 2 params → 4XX200
GET
/accounts/{account_id}/access/users/{user_id}/last_seen_identity
APIs.io Engineering Platform Get last seen identity
zero-trust-users-get-last-seen-identity 2 params → 4XX200

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are access_identity (18 properties), access_users (11 properties), access_schemas-device_posture_rule (9 properties), access_result_info (4 properties). Each schema is shown below with its type and property counts.

access_uid
string
The unique API identifier for the user.
access_active_device_count
number
The number of active devices registered to the user.
access_device_posture_check
object
2 properties
access_api-response-collection
object
access_last_successful_login
string
The time at which the user last successfully logged in.
access_nonce
string
access_uuid
string
UUID
access_string_key_map_device_session
object
access_users
object
11 properties
access_identifier
string
Identifier
access_email
string
The email of the user.
access_result_info
object
4 properties
access_api-response-common-failure
object
4 properties 4 required
access_geo
object
1 property
access_schemas-device_posture_rule
object
9 properties
access_api-response-common
object
3 properties 3 required
access_last_seen_identity_response
access_failed_login_response
access_users_components-schemas-response_collection
access_active_sessions_response
access_messages
array
access_active_session_response
access_schemas-seat_uid
string
The unique API identifier for the Zero Trust seat.
access_users_components-schemas-name
string
The name of the user.
access_timestamp
string
access_device_session
object
1 property
access_schemas-access_seat
boolean
True if the user has authenticated with Cloudflare Access.
access_schemas-gateway_seat
boolean
True if the user has logged into the WARP client.
access_identity
object
18 properties
access_api-response-single
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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