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's Organizations API

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

This API exposes 3 operations across 2 paths, and defines 13 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 13 schemas 1 DELETE2 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 User's Organizations 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 — 1 DELETE, 2 GET. Each is listed below with its method, path, parameters, and response codes.

User's Organizations 3
GET
/user/organizations
APIs.io Engineering Platform List Organizations
user'-s-organizations-list-organizations 7 params → 4XX200
DELETE
/user/organizations/{organization_id}
APIs.io Engineering Platform Leave Organization
user'-s-organizations-leave-organization 1 param body → 4XX200
GET
/user/organizations/{organization_id}
APIs.io Engineering Platform Organization Details
user'-s-organizations-organization-details 1 param → 4XX200

Schemas 13

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

iam_organization
object
5 properties
iam_collection_organization_response
iam_common_components-schemas-identifier
string
Identifier
iam_api-response-collection
object
iam_result_info
object
4 properties
iam_schemas-permissions
array
Access permissions for this User.
iam_single_organization_response
iam_api-response-common
object
3 properties 3 required
iam_api-response-single
object
iam_api-response-common-failure
object
4 properties 4 required
iam_components-schemas-status
string
Whether the user is a member of the organization or has an invitation pending.
iam_messages
array
iam_schemas-name
string
Organization name.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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