This API exposes
10 operations
across 6 paths,
and defines 8 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.
10 operations6 paths8 schemas2 DELETE4 GET1 PATCH1 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
APIs.io Engineering Platform Oauth-Authorizations 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 10
Across 6 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 1 PATCH, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are app-permissions (45 properties), simple-user (21 properties), nullable-simple-user (21 properties), authorization (15 properties). Each schema is shown below with its type and property counts.
nullable-simple-user
object
A GitHub user.
21 properties18 required
basic-error
object
Basic Error
4 properties
validation-error
object
Validation Error
3 properties2 required
nullable-scoped-installation
object
7 properties5 required
app-permissions
object
The permissions granted to the user access token.
45 properties
simple-user
object
A GitHub user.
21 properties18 required
authorization
object
The authorization for an OAuth app, GitHub App, or a Personal Access Token.
15 properties13 required
application-grant
object
The authorization associated with an OAuth Access.
7 properties6 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
