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 Access Authentication Logs API

The Access Authentication Logs API from APIs.io Engineering Platform — 1 operation(s) for access authentication logs.

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 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 Access Authentication Logs 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 GET. Each is listed below with its method, path, parameters, and response codes.

Access Authentication Logs 1
GET
/accounts/{account_id}/access/logs/access_requests
APIs.io Engineering Platform Get Access authentication logs
access-authentication-logs-get-access-authentication-logs 5 params → 4XX200

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are access_access-requests (9 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_schemas-email
string
The email address of the authenticating user.
access_connection
string
The IdP used to authenticate.
access_api-response-common
object
3 properties 3 required
access_ip
string
The IP address of the authenticating user.
access_api-response-common-failure
object
4 properties 4 required
access_messages
array
access_ray_id
string
The unique identifier for the request to Cloudflare.
access_app_domain
string
The URL of the Access application.
access_allowed
boolean
The result of the authentication event.
access_action
string
The event that occurred, such as a login attempt.
access_app_uid
string
The unique identifier for the Access application.
access_access-requests
object
9 properties
access_timestamp
string
access_access-requests_components-schemas-response_collection
access_identifier
string
Identifier

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-access-authentication-logs-api-openapi.yml Raw ↑