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

The User API from APIs.io Engineering Platform — 2 operation(s) for user.

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

3 operations 2 paths 11 schemas 2 GET1 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 User 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 3

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

User 3
GET
/user
APIs.io Engineering Platform User Details
user-user-details → 4XX200
PATCH
/user
APIs.io Engineering Platform Edit User
user-edit-user body → 4XX200
GET
/me
APIs.io Engineering Platform Get authenticated user
getAuthenticatedUser → 200401500

Schemas 11

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

iam_last_name
string
User's last name
iam_country
string
The country in which the user lives.
iam_first_name
string
User's first name
iam_zipcode
string
The zipcode or postal code where the user lives.
iam_api-response-common
object
3 properties 3 required
getAuthenticatedUser
object
2 properties
iam_api-response-single
object
iam_single_user_response
iam_api-response-common-failure
object
4 properties 4 required
iam_telephone
string
User's telephone number
iam_messages
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-user-api-openapi.yml Raw ↑